package core

  1. Overview
  2. Docs
Industrial strength alternative to OCaml's standard library

Install 

dune-project
 Dependency

github.com Changelog MIT License Edit opam file Versions (13)

Authors

  1. J
    Jane Street Group, LLC

Maintainers

  1. J
    Jane Street developers

Sources

v0.17.0.tar.gz
sha256=b0e23c1b1049e48cbbaa596d49927c66e6026506031bd7f5b485af6e9475b4e3

doc/core/Core/Info/index.html

Module Core.InfoSource

This module extends Base.Info, which provides a type for info-level debug messages.

Sourcemodule type S = Base.Info.S

Serialization and comparison force the lazy message.

Sourceval compare : t -> t -> int
Sourceval compare__local : t -> t -> int
Sourceval equal : t -> t -> bool
Sourceval equal__local : t -> t -> bool
Sourceval globalize : t -> t
Sourceval hash_fold_t : Base.Hash.state -> t -> Base.Hash.state
include Sexplib0.Sexpable.S with type t := t
Sourceval t_of_sexp : Sexplib0.Sexp.t -> t
Sourceval sexp_of_t : t -> Sexplib0.Sexp.t
Sourceval t_sexp_grammar : t Sexplib0.Sexp_grammar.t
Sourceval invariant : t -> unit
Sourceval to_string_hum : 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 : t -> string

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

Sourceval of_string : string -> 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 -> t
Sourceval of_lazy_sexp : Base.Sexp.t Base.Lazy.t -> t
Sourceval of_thunk : (unit -> string) -> t
Sourceval of_lazy_t : t Base.Lazy.t -> t
Sourceval create : ?here:Lexing.position -> ?strict:unit -> string -> 'a -> ('a -> Base.Sexp.t) -> 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 create_s : Base.Sexp.t -> t
Sourceval createf : ('a, unit, string, t) format4 -> 'a

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

Sourceval tag : t -> tag:string -> t

Adds a string to the front.

Sourceval tag_s : t -> tag:Base.Sexp.t -> t

Adds a sexp to the front.

Sourceval tag_s_lazy : t -> tag:Base.Sexp.t Base.Lazy.t -> t

Adds a lazy sexp to the front.

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

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

Sourceval of_list : t list -> t

Combines multiple infos into one.

Sourceval of_exn : ?backtrace:[ `Get | `This of string ] -> exn -> 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 : t -> exn
Sourceval pp : Base.Formatter.t -> t -> unit
include Bin_prot.Binable.S with type t := t
include Bin_prot.Binable.S_only_functions with type t := t
Sourceval bin_size_t : t Bin_prot.Size.sizer
Sourceval bin_write_t : t Bin_prot.Write.writer
Sourceval bin_read_t : t Bin_prot.Read.reader
Sourceval __bin_read_t__ : (int -> t) Bin_prot.Read.reader

This function only needs implementation if t exposed to be a polymorphic variant. Despite what the type reads, this does *not* produce a function after reading; instead it takes the constructor tag (int) before reading and reads the rest of the variant t afterwards.

Sourceval bin_shape_t : Bin_prot.Shape.t
Sourcemodule Diff : sig ... end
Sourcemodule Stable : sig ... end
Sourcemodule Extend (Info : Base.Info.S) : sig ... end