package core_extended

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type

Immediate_short_string represents strings of length 0-7 stored as an integer.

Invariant: all strings are represented as non-negative integers, and Option.none is represented as a non-negative integer distinct from the representation of all strings.

Invariant: the integer encoding ensures that compare x y is fast and corresponds with String.compare (to_string x) (to_string y).

include Immediate_kernel.S_no_option
type t
include Typerep_lib.Typerepable.S with type t := t
val typename_of_t : t Typerep_lib.Typename.t
include Ppx_hash_lib.Hashable.S with type t := t
val globalize : t -> t
include Core.Identifiable.S with type t := t
include Bin_prot.Binable.S with type t := t
include Bin_prot.Binable.S_only_functions with type t := 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
include Ppx_hash_lib.Hashable.S with type t := t
include Sexplib0.Sexpable.S with type t := t
val t_of_sexp : Sexplib0.Sexp.t -> t
include Ppx_compare_lib.Comparable.S with type t := t
include Ppx_hash_lib.Hashable.S with type t := t
val sexp_of_t : t -> Sexplib0.Sexp.t
include Base.Stringable.S with type t := t
val of_string : string -> t
val to_string : t -> string
include Base.Pretty_printer.S with type t := t
val pp : Base.Formatter.t -> t -> unit
include Core.Comparable.S_binable with type t := t
include Base.Comparable.S with type t := t
include Base.Comparisons.S with type t := t
include Base.Comparisons.Infix with type t := t
val (>=) : t -> t -> bool
val (<=) : t -> t -> bool
val (=) : t -> t -> bool
val (>) : t -> t -> bool
val (<) : t -> t -> bool
val (<>) : t -> t -> bool
val compare : t -> t -> int

compare t1 t2 returns 0 if t1 is equal to t2, a negative integer if t1 is less than t2, and a positive integer if t1 is greater than t2.

val min : t -> t -> t
val max : t -> t -> t
val ascending : t -> t -> int

ascending is identical to compare. descending x y = ascending y x. These are intended to be mnemonic when used like List.sort ~compare:ascending and List.sort ~cmp:descending, since they cause the list to be sorted in ascending or descending order, respectively.

val descending : t -> t -> int
val between : t -> low:t -> high:t -> bool

between t ~low ~high means low <= t <= high

val clamp_exn : t -> min:t -> max:t -> t

clamp_exn t ~min ~max returns t', the closest value to t such that between t' ~low:min ~high:max is true.

Raises if not (min <= max).

val clamp : t -> min:t -> max:t -> t Base.Or_error.t
include Base.Comparator.S with type t := t
type comparator_witness
val validate_lbound : min:t Core.Maybe_bound.t -> t Validate.check
val validate_ubound : max:t Core.Maybe_bound.t -> t Validate.check
val validate_bound : min:t Core.Maybe_bound.t -> max:t Core.Maybe_bound.t -> t Validate.check
include Core.Hashable.S_binable with type t := t
include Ppx_hash_lib.Hashable.S with type t := t
val hash_fold_t : Base.Hash.state -> t -> Base.Hash.state
val hash : t -> Base.Hash.hash_value
val hashable : t Base.Hashable.t
module Table : Core.Hashtbl.S_binable with type key = t
module Hash_set : Core.Hash_set.S_binable with type elt = t
module Hash_queue : Core.Hash_queue.S with type key = t
include Core.Equal.S with type t := t
val equal : t Base.Equal.equal
include Core.Quickcheckable with type t := t
val quickcheck_generator : t Base_quickcheck.Generator.t
val quickcheck_observer : t Base_quickcheck.Observer.t
val quickcheck_shrinker : t Base_quickcheck.Shrinker.t

Lexicographic.compare x y = String.compare (to_string x) (to_string y)

val length : t -> int
val get : t -> int -> char
val of_char : char -> t
val mem : t -> char -> bool
include Core.Intable with type t := t
val of_int_exn : int -> t
val to_int_exn : t -> int
val unsafe_to_int : t -> int
val unsafe_of_int : int -> t
val empty : t
val is_empty : t -> bool
val unsafe_of_bigstring : pos:int -> len:int -> Core.Bigstring.t -> t
val of_iobuf_peek : ?pos:int -> ?len:int -> ([> Core.read ], _) Iobuf.t -> t
val of_iobuf_consume : ?len:int -> ([> Core.read ], Iobuf.seek) Iobuf.t -> t
val to_iobuf_poke : t -> ?pos:int -> (Core.read_write, _) Iobuf.t -> unit
val to_iobuf_fill : t -> (Core.read_write, Iobuf.seek) Iobuf.t -> unit
module Padded : sig ... end

WARNING: using the padded functions to convert to a bigstring / iobuf will ignore ~len arguments that are less than the length of the source t!

val unsafe_get : t -> int -> char
val unsafe_of_iobuf_peek : pos:int -> len:int -> ([> Core.read ], _) Iobuf.t -> t
val unsafe_of_iobuf_consume : len:int -> ([> Core.read ], Iobuf.seek) Iobuf.t -> t
val unsafe_to_iobuf_poke : t -> pos:int -> (Core.read_write, _) Iobuf.t -> unit
val unsafe_to_iobuf_fill : t -> (Core.read_write, Iobuf.seek) Iobuf.t -> unit
val unsafe_to_bigstring : t -> pos:int -> Core.Bigstring.t -> unit
val of_bytes : Core.Bytes.t -> t
val of_uint32 : Int_repr.Uint32.t -> t
val of_local_string : string -> t
val to_local_string : t -> string
val of_substring : string -> pos:int -> len:int -> t
val to_local_bytes : t -> Core.Bytes.t
val max_length : int
val is_valid_length : int -> bool
val is_valid_string : string -> bool
val pad_right : t -> char:char -> len:int -> t
val append_exn : t -> t -> t

Raises if the result exceeds max_length.

val gen_with_length : int -> char Core.Quickcheck.Generator.t -> t Core.Quickcheck.Generator.t
module To_bigstring : Core.Blit.S_distinct with type src := t with type dst := Core.bigstring
module Option : sig ... end
module Stable : sig ... end
OCaml

Innovation. Community. Security.