An Ogre document.
A concrete representation of a database.
type t = docinclude Core_kernel.Bin_prot.Binable.S with type t := tinclude Bin_prot.Binable.S_only_functions with type t := tval bin_size_t : t Bin_prot.Size.sizerval bin_write_t : t Bin_prot.Write.writerval bin_read_t : t Bin_prot.Read.readerval __bin_read_t__ : (int -> t) Bin_prot.Read.readerThis 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.tval bin_writer_t : t Bin_prot.Type_class.writerval bin_reader_t : t Bin_prot.Type_class.readerval bin_t : t Bin_prot.Type_class.tinclude Ppx_compare_lib.Comparable.S with type t := tinclude Sexplib0.Sexpable.S with type t := tval t_of_sexp : Sexplib0.Sexp.t -> tval sexp_of_t : t -> Sexplib0.Sexp.tval empty : docempty creates an empty document
val is_empty : doc -> boolis_empty x is true iff x is empty.
val merge : doc -> doc -> doc Core_kernel.Or_error.tmerge d1 d2 merges two documents in one. Returns an error, if documents contain inconsistent declarations.
val load : Core_kernel.In_channel.t -> doc Core_kernel.Or_error.tload chan loads a document from a channel, returns an error if a document is not well-formed, raises an exception if a system error has occurred.
val save : doc -> Core_kernel.Out_channel.t -> unitsave doc out stores the document in a channel. Raises an exception in case of a system error.
val from_file : string -> doc Core_kernel.Or_error.tfrom_file name reads a document from a file with the given name, returns an error, if a document is not well-formed, raises an exception if a system error has occurred.
val from_string : string -> doc Core_kernel.Or_error.tfrom_string data parses document from data. Returns an error if a document is not well-formed.
val to_string : doc -> stringto_string doc returns a textual representation of a document
val to_file : doc -> string -> unitto_file doc name stores a document to a file with the given name.
val pp : Format.formatter -> doc -> unitpp ppf doc prints a doc in the specified formatter ppf
val pp_yaml : Format.formatter -> doc -> unitpp_yamp ppf doc prints doc to ppf in the YAML format.
clear doc removes all facts from the document.
Useful for extracting scheme from a document.
val declarations : doc -> intdeclarations doc returns the number of declarations in the document
val definitions : doc -> intdefinitions doc returns the number of facts that defined in the document.