package accessor

  1. Overview
  2. Docs
Module type
Class type
type +'a t

t is an appendable type for defining many_getter accessors. See the documentation of Accessor.many_getter for more information.

include Base.Monad.S with type 'a t := 'a t
val (>>=) : 'a t -> ('a -> 'b t) -> 'b t

t >>= f returns a computation that sequences the computations represented by two monad elements. The resulting computation first does t to yield a value v, and then runs the computation returned by f v.

val (>>|) : 'a t -> ('a -> 'b) -> 'b t

t >>| f is t >>= (fun a -> return (f a)).

module Monad_infix : sig ... end
val bind : 'a t -> f:('a -> 'b t) -> 'b t

bind t ~f = t >>= f

val return : 'a -> 'a t

return v returns the (trivial) computation that returns v.

val map : 'a t -> f:('a -> 'b) -> 'b t

map t ~f is t >>| f.

val join : 'a t t -> 'a t

join t is t >>= (fun t' -> t').

val ignore_m : 'a t -> unit t

ignore_m t is map t ~f:(fun _ -> ()). ignore_m used to be called ignore, but we decided that was a bad name, because it shadowed the widely used Stdlib.ignore. Some monads still do let ignore = ignore_m for historical reasons.

val all : 'a t list -> 'a list t
val all_unit : unit t list -> unit t

Like all, but ensures that every monadic value in the list produces a unit value, all of which are discarded rather than being collected into a list.

module Let_syntax : sig ... end

These are convenient to have in scope when programming with a monad:

val access : 'a -> 'a t

access a "accesses" a.

val empty : _ t

Don't access anything.

val append : 'a t -> 'a t -> 'a t

append a b accesses everything a accesses, then accesses everything b accesses.

val of_list : 'a t Base.list -> 'a t

Append all the ts in a list together.

module O : sig ... end
include module type of O
val (@) : 'a t -> 'a t -> 'a t
val map_reduce : 'a t -> empty:'r -> combine:('r -> 'r -> 'r) -> f:('a -> 'r) -> 'r
val of_many : (_, 'a, _) Many.t -> 'a t
val of_nonempty : (_, 'a, _) Nonempty.t -> 'a t
val of_nonempty_getter : 'a Nonempty_getter.t -> 'a t
module Make_access (T : sig ... end) : sig ... end
module Make_access3 (T : sig ... end) : sig ... end
module Make_access4 (T : sig ... end) : sig ... end

Innovation. Community. Security.