Module Core_kernel.Error

This module extends Base.Error with bin_io.

type t = Base__Error.t
val compare : t -> t -> int
val equal : t -> t -> bool
val hash_fold_t : Base.Hash.state -> t -> Base.Hash.state
val hash : t -> Base.Hash.hash_value
val t_of_sexp : Base.Sexp.t -> t
val sexp_of_t : t -> Base.Sexp.t
val invariant : t Base__.Invariant_intf.inv
val to_string_hum : t -> string
val to_string_mach : t -> string
val to_string_hum_deprecated : t -> string
val of_string : string -> t
val of_lazy : string Base.Lazy.t -> t
val of_thunk : (unit -> string) -> t
val of_lazy_t : t Base.Lazy.t -> t
val create : ?⁠here:Base__.Source_code_position0.t -> ?⁠strict:unit -> string -> 'a -> ('a -> Base.Sexp.t) -> t
val create_s : Base.Sexp.t -> t
val createf : ('a, unit, string, t) Stdlib.format4 -> 'a
val tag : t -> tag:string -> t
val tag_s : t -> tag:Base.Sexp.t -> t
val tag_arg : t -> string -> 'a -> ('a -> Base.Sexp.t) -> t
val of_list : ?⁠trunc_after:int -> t list -> t
val of_exn : ?⁠backtrace:[ `Get | `This of string ] -> exn -> t
val to_exn : t -> exn
val pp : Base.Formatter.t -> t -> unit
val raise : t -> 'a
val raise_s : Base.Sexp.t -> 'a
val to_info : t -> Base.Info.t
val of_info : Base.Info.t -> t

This include is the source of the bin_io functions.

include Core_kernel__.Info_intf.Extension with type t := t
type t
include Bin_prot.Binable.S with type t := t
type t
include Bin_prot.Binable.S_only_functions with type t := t
type t
val bin_size_t : t Bin_prot.Size.sizer
val bin_write_t : t Bin_prot.Write.writer
val bin_read_t : t Bin_prot.Read.reader
val __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.

val bin_shape_t : Bin_prot.Shape.t
val bin_writer_t : t Bin_prot.Type_class.writer
val bin_reader_t : t Bin_prot.Type_class.reader
val bin_t : t Bin_prot.Type_class.t
module Stable : sig ... end
val failwiths : ?⁠strict:Core_kernel__.Import.unit -> ?⁠here:Stdlib.Lexing.position -> Core_kernel__.Import.string -> 'a -> ('a -> Base.Sexp.t) -> _
failwiths ?strict ?here message a sexp_of_a
= Error.raise (Error.create ?strict ?here s a sexp_of_a)

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

The pa_fail preprocessor replaces failwiths with failwiths ?here:[%here] so that one does not need to (and cannot) supply [%here]. pa_fail does not add ?here:[%here] to Error.failwiths.

In this signature we write ?here:Lexing.position rather than ?here:Source_code_position.t to avoid a circular dependency.

failwithp here is like failwiths ~here, except that you can provide a source position yourself (which is only interesting if you don't provide [%here]).

val failwithp : ?⁠strict:Core_kernel__.Import.unit -> Stdlib.Lexing.position -> Core_kernel__.Import.string -> 'a -> ('a -> Base.Sexp.t) -> _