package containers

You can search for identifiers within the package.

in-package search v0.2.0

A modular, clean and powerful extension of the OCaml standard library

Install

Dune Dependency

github.com Readme Changelog Edit opam file Versions (23)

Authors

C

c-cube

Maintainers

C

c-cube

Sources

containers-3.15.tbz

sha256=92143ceb4785ae5f8a07f3ab4ab9f6f32d31ead0536e9be4fdb818dd3c677e58

sha512=5fa80189d0e177af2302b48e72b70299d51fc36ac2019e1cbf389ff6a7f4705b10089405b5a719b3e4845b0d1349a47a967f865dc2e4e3f0d5a0167ef6c31431

doc/containers/CCCanonical_sexp/index.html

Module `CCCanonical_sexp`Source

Canonical S-expressions

See wikipedia. These S-expressions are binary safe.

since 3.3

Sourcetype 'a or_error = ('a, string) result

Sourcetype 'a gen = unit -> 'a option

Sourcemodule type SEXP = CCSexp_intf.BASIC_SEXP

Sourcemodule type S = CCSexp_intf.S0

Sourcemodule Make (Sexp : SEXP) : S with type t = Sexp.t

Basics

Sourcetype t = [

| `Atom of string
| `List of t list

]

A simple, structural representation of S-expressions. Compatible with CCSexp.

include S with type t := t

Sourcetype sexp = t

Re-exports

Sourceval list : t list -> t

Make a Sexpr of this list.

since 2.8

Constructors

Sourceval of_int : int -> t

Sourceval of_bool : bool -> t

Sourceval of_list : t list -> t

Sourceval of_rev_list : t list -> t

Reverse the list.

Sourceval of_float : float -> t

Sourceval of_unit : t

Sourceval of_pair : (t * t) -> t

Sourceval of_triple : (t * t * t) -> t

Sourceval of_quad : (t * t * t * t) -> t

Sourceval of_variant : string -> t list -> t

of_variant name args is used to encode algebraic variants into a S-expr. For instance of_variant "some" [of_int 1] represents the value Some 1.

Sourceval of_field : string -> t -> t

Used to represent one record field.

Sourceval of_record : (string * t) list -> t

Represent a record by its named fields.

Printing

Sourceval to_buf : Buffer.t -> t -> unit

Sourceval to_string : t -> string

Sourceval to_file : string -> t -> unit

Sourceval to_file_iter : string -> t CCSexp_intf.iter -> unit

Print the given iter of expressions to a file.

Sourceval to_chan : out_channel -> t -> unit

Sourceval pp : Format.formatter -> t -> unit

Pretty-printer nice on human eyes (including indentation).

Sourceval pp_noindent : Format.formatter -> t -> unit

Raw, direct printing as compact as possible.

Parsing

Sourceval parse_string : string -> t CCSexp_intf.or_error

Parse a string.

Sourceval parse_string_list : string -> t list CCSexp_intf.or_error

Parse a string into a list of S-exprs.

since 2.8

Sourceval parse_chan : in_channel -> t CCSexp_intf.or_error

Parse a S-expression from the given channel. Can read more data than necessary, so don't use this if you need finer-grained control (e.g. to read something else after the S-exp).

Sourceval parse_chan_gen : in_channel -> t CCSexp_intf.or_error CCSexp_intf.gen

Parse a channel into a generator of S-expressions.

Sourceval parse_chan_list : in_channel -> t list CCSexp_intf.or_error

Sourceval parse_file : string -> t CCSexp_intf.or_error

Open the file and read a S-exp from it.

Sourceval parse_file_list : string -> t list CCSexp_intf.or_error