jon.recoil.org

Module Base.ErrorSource

A lazy string, implemented with Info, but intended specifically for error messages.

Sourcetype t = private Base.Info.t

Serialization and comparison force the lazy message.

Sourceval compare : Base.Error.t -> Base.Error.t -> int
Sourceval equal : Base.Error.t -> Base.Error.t -> bool
Sourceval globalize : Base.Error.t -> Base.Error.t
include Sexplib0.Sexpable.S with type t := Base.Error.t
Sourceval invariant : Base.Error.t -> unit
Sourceval to_string_hum : Base.Error.t -> string

to_string_hum forces the lazy message, which might be an expensive operation.

to_string_hum usually produces a sexp; however, it is guaranteed that to_string_hum (of_string s) = s.

If this string is going to go into a log file, you may find it useful to ensure that the string is only one line long. To do this, use to_string_mach t.

Sourceval to_string_mach : Base.Error.t -> string

to_string_mach t outputs t as a sexp on a single line.

Sourceval of_string : string -> Base.Error.t

Be careful that the body of the lazy or thunk does not access mutable data, since it will only be called at an undetermined later point.

Sourceval of_lazy : string Base.Lazy.t -> Base.Error.t
Sourceval of_thunk : (unit -> string) -> Base.Error.t
Sourceval create : ?here:Stdlib.Lexing.position -> ?strict:unit -> string -> 'a -> ('a -> Base.Sexp.t) -> Base.Error.t

For create message a sexp_of_a, sexp_of_a a is lazily computed, when the info is converted to a sexp. So if a is mutated in the time between the call to create and the sexp conversion, those mutations will be reflected in the sexp. Use ~strict:() to force sexp_of_a a to be computed immediately.

Sourceval createf : ('a, unit, string, Base.Error.t) Stdlib.format4 -> 'a

Constructs a t containing only a string from a format. This eagerly constructs the string.

Sourceval tag : Base.Error.t -> tag:string -> Base.Error.t

Adds a string to the front.

Adds a sexp to the front.

Adds a lazy sexp to the front.

Sourceval tag_arg : Base.Error.t -> string -> 'a -> ('a -> Base.Sexp.t) -> Base.Error.t

Adds a string and some other data in the form of an s-expression at the front.

Sourceval of_list : Base.Error.t list -> Base.Error.t

Combines multiple infos into one.

Sourceval of_exn : ?backtrace:[ `Get | `This of string ] -> exn -> Base.Error.t

of_exn and to_exn are primarily used with Error, but their definitions have to be here because they refer to the underlying representation.

~backtrace:`Get attaches the backtrace for the most recent exception. The same caveats as for Printexc.print_backtrace apply. ~backtrace:(`This s) attaches the backtrace s. The default is no backtrace.

Sourceval to_exn : Base.Error.t -> exn
Sourcemodule Internal_repr : sig ... end
Sourceval raise : Base.Error.t -> _

Note that the exception raised by this function maintains a reference to the t passed in.

Sourceval raise_s : Base.Sexp.t -> _