Module Core_kernel.Ref.Permissioned

type ('a, -'perms) t
include sig ... end
val t_of_sexp : (Sexplib.Sexp.t ‑> 'a) ‑> (Sexplib.Sexp.t ‑> 'perms) ‑> Sexplib.Sexp.t ‑> ('a, 'perms) t
val sexp_of_t : ('a ‑> Sexplib.Sexp.t) ‑> ('perms ‑> Sexplib.Sexp.t) ‑> ('a, 'perms) t ‑> Sexplib.Sexp.t
val bin_t : 'a Bin_prot.Type_class.t ‑> 'perms Bin_prot.Type_class.t ‑> ('a, 'perms) t Bin_prot.Type_class.t
val bin_read_t : 'a Bin_prot.Read.reader ‑> 'perms Bin_prot.Read.reader ‑> ('a, 'perms) t Bin_prot.Read.reader
val __bin_read_t__ : 'a Bin_prot.Read.reader ‑> 'perms Bin_prot.Read.reader ‑> (Core_kernel__.Import.int ‑> ('a, 'perms) t) Bin_prot.Read.reader
val bin_reader_t : 'a Bin_prot.Type_class.reader ‑> 'perms Bin_prot.Type_class.reader ‑> ('a, 'perms) t Bin_prot.Type_class.reader
val bin_size_t : 'a Bin_prot.Size.sizer ‑> 'perms Bin_prot.Size.sizer ‑> ('a, 'perms) t Bin_prot.Size.sizer
val bin_write_t : 'a Bin_prot.Write.writer ‑> 'perms Bin_prot.Write.writer ‑> ('a, 'perms) t Bin_prot.Write.writer
val bin_writer_t : 'a Bin_prot.Type_class.writer ‑> 'perms Bin_prot.Type_class.writer ‑> ('a, 'perms) t Bin_prot.Type_class.writer
include Container.S1_permissions with type (a, perms) t := (a, perms) t
type ('a, -'permissions) t
val mem : ('a, [> Perms.Export.read ]) t ‑> 'a ‑> equal:('a ‑> 'a ‑> Core_kernel__.Import.bool) ‑> Core_kernel__.Import.bool

Checks whether the provided element is there, using polymorphic compare if equal is not provided.

val length : (_, [> Perms.Export.read ]) t ‑> Core_kernel__.Import.int
val is_empty : (_, [> Perms.Export.read ]) t ‑> Core_kernel__.Import.bool
val iter : ('a, [> Perms.Export.read ]) t ‑> f:('a ‑> Core_kernel__.Import.unit) ‑> Core_kernel__.Import.unit
val fold : ('a, [> Perms.Export.read ]) t ‑> init:'accum ‑> f:('accum ‑> 'a ‑> 'accum) ‑> 'accum

fold t ~init ~f returns f (... f (f (f init e1) e2) e3 ...) en, where e1..en are the elements of t

val fold_result : ('a, [> Perms.Export.read ]) t ‑> init:'accum ‑> f:('accum ‑> 'a ‑> ('accum, 'e) Result.t) ‑> ('accum, 'e) Result.t

fold_result t ~init ~f is a short-circuiting version of fold that runs in the Result monad. If f returns an Error _, that value is returned without any additional invocations of f.

val fold_until : ('a, [> Perms.Export.read ]) t ‑> init:'accum ‑> f:('accum ‑> 'a ‑> ('accum, 'stop) Container_intf.Continue_or_stop.t) ‑> ('accum, 'stop) Container_intf.Finished_or_stopped_early.t

fold_until t ~init ~f is a short-circuiting version of fold. If f returns Stop _ the computation ceases and results in that value. If f returns Continue _, the fold will proceed.

val exists : ('a, [> Perms.Export.read ]) t ‑> f:('a ‑> Core_kernel__.Import.bool) ‑> Core_kernel__.Import.bool

Returns true if and only if there exists an element for which the provided function evaluates to true. This is a short-circuiting operation.

val for_all : ('a, [> Perms.Export.read ]) t ‑> f:('a ‑> Core_kernel__.Import.bool) ‑> Core_kernel__.Import.bool

Returns true if and only if the provided function evaluates to true for all elements. This is a short-circuiting operation.

val count : ('a, [> Perms.Export.read ]) t ‑> f:('a ‑> Core_kernel__.Import.bool) ‑> Core_kernel__.Import.int

Returns the number of elements for which the provided function evaluates to true.

val sum : (module Core_kernel__.Import.Commutative_group.S with type t = 'sum) ‑> ('a, [> Perms.Export.read ]) t ‑> f:('a ‑> 'sum) ‑> 'sum

Returns the sum of f i for i in the container

val find : ('a, [> Perms.Export.read ]) t ‑> f:('a ‑> Core_kernel__.Import.bool) ‑> 'a Core_kernel__.Import.option

Returns as an option the first element for which f evaluates to true.

val find_map : ('a, [> Perms.Export.read ]) t ‑> f:('a ‑> 'b Core_kernel__.Import.option) ‑> 'b Core_kernel__.Import.option

Returns the first evaluation of f that returns Some, and returns None if there is no such element.

val to_list : ('a, [> Perms.Export.read ]) t ‑> 'a Core_kernel__.Import.list
val to_array : ('a, [> Perms.Export.read ]) t ‑> 'a Core_kernel__.Import.array
val min_elt : ('a, [> Perms.Export.read ]) t ‑> cmp:('a ‑> 'a ‑> Core_kernel__.Import.int) ‑> 'a Core_kernel__.Import.option

Returns a min (resp max) element from the collection using the provided cmp function. In case of a tie, the first element encountered while traversing the collection is returned. The implementation uses fold so it has the same complexity as fold. Returns None iff the collection is empty.

val max_elt : ('a, [> Perms.Export.read ]) t ‑> cmp:('a ‑> 'a ‑> Core_kernel__.Import.int) ‑> 'a Core_kernel__.Import.option
val create : 'a ‑> ('a, [< _ Perms.Export.perms ]) t
val read_only : ('a, [> Perms.Export.read ]) t ‑> ('a, Perms.Export.read) t
val (!) : ('a, [> Perms.Export.read ]) t ‑> 'a

get and (!) are two names for the same function.

val get : ('a, [> Perms.Export.read ]) t ‑> 'a
val set : ('a, [> Perms.Export.write ]) t ‑> 'a ‑> Core_kernel__.Import.unit

set and (:=) are two names for the same function.

val (:=) : ('a, [> Perms.Export.write ]) t ‑> 'a ‑> Core_kernel__.Import.unit
val of_ref : 'a Core_kernel__.Import.ref ‑> ('a, [< Perms.Export.read_write ]) t
val to_ref : ('a, [> Perms.Export.read_write ]) t ‑> 'a Core_kernel__.Import.ref
val swap : ('a, [> Perms.Export.read_write ]) t ‑> ('a, [> Perms.Export.read_write ]) t ‑> Core_kernel__.Import.unit
val replace : ('a, [> Perms.Export.read_write ]) t ‑> ('a ‑> 'a) ‑> Core_kernel__.Import.unit
val set_temporarily : ('a, [> Perms.Export.read_write ]) t ‑> 'a ‑> f:(Core_kernel__.Import.unit ‑> 'b) ‑> 'b