package tezos-protocol-environment

You can search for identifiers within the package.

in-package search v0.2.0

Interface layer between the protocols and the shell

Install

Dune Dependency

www.tezos.com Readme Edit opam file Versions (3)

Authors

T

Tezos devteam

Maintainers

C

contact@tezos.com

Sources

tezos-16.0.tar.gz

sha256=ad9e08819871c75ba6f4530b125f7d157799398e4d77a1e6bfea9d91ff37ff55

sha512=c5dc4d40cc09bc6980fbbdb5c2e105bf4252cf9cfcb2b49660b0ebe4dc789f6709ec3b3bf2f87d81580d3eed9521eeb1c960f24d9b14eb0285aaba1f84d10a9b

doc/tezos-protocol-environment.structs/Tezos_protocol_environment_structs/V1/Option/index.html

Module `V1.Option`Source

include module type of struct include Option end

Options

Sourcetype 'a t = 'a option =

| None
| Some of 'a

The type for option values. Either None or a value Some v.

Sourceval none : 'a option

none is None.

Sourceval some : 'a -> 'a option

some v is Some v.

Sourceval value : 'a option -> default:'a -> 'a

value o ~default is v if o is Some v and default otherwise.

Sourceval get : 'a option -> 'a

get o is v if o is Some v and raise otherwise.

raises Invalid_argument
if o is None.

Sourceval bind : 'a option -> ('a -> 'b option) -> 'b option

bind o f is f v if o is Some v and None if o is None.

Sourceval join : 'a option option -> 'a option

join oo is Some v if oo is Some (Some v) and None otherwise.

Sourceval map : ('a -> 'b) -> 'a option -> 'b option

map f o is None if o is None and Some (f v) is o is Some v.

Sourceval fold : none:'a -> some:('b -> 'a) -> 'b option -> 'a

fold ~none ~some o is none if o is None and some v if o is Some v.

Sourceval iter : ('a -> unit) -> 'a option -> unit

iter f o is f v if o is Some v and () otherwise.

Predicates and comparisons

Sourceval is_none : 'a option -> bool

is_none o is true if and only if o is None.

Sourceval is_some : 'a option -> bool

is_some o is true if and only if o is Some o.

Sourceval equal : ('a -> 'a -> bool) -> 'a option -> 'a option -> bool

equal eq o0 o1 is true if and only if o0 and o1 are both None or if they are Some v0 and Some v1 and eq v0 v1 is true.

Sourceval compare : ('a -> 'a -> int) -> 'a option -> 'a option -> int

compare cmp o0 o1 is a total order on options using cmp to compare values wrapped by Some _. None is smaller than Some _ values.

Converting

Sourceval to_result : none:'e -> 'a option -> ('a, 'e) result

to_result ~none o is Ok v if o is Some v and Error none otherwise.

Sourceval to_list : 'a option -> 'a list

to_list o is [] if o is None and [v] if o is Some v.

Sourceval to_seq : 'a option -> 'a Seq.t

to_seq o is o as a sequence. None is the empty sequence and Some v is the singleton sequence containing v.

Sourceval (>>=) : 'a option -> ('a -> 'b option) -> 'b option

Sourceval (>>|) : 'a option -> ('a -> 'b) -> 'b option

Sourceval unopt : default:'a -> 'a t -> 'a

Sourceval unopt_map : f:('a -> 'b) -> default:'b -> 'a t -> 'b

Sourceval unopt_exn : exn -> 'a t -> 'a

Sourceval unopt_assert : loc:(string * int * int * 'a) -> 'b t -> 'b

Sourceval first_some : 'a t -> 'a t -> 'a t

Source

val pp : 
  ?default:string ->
  (Format.formatter -> 'a -> unit) ->
  Format.formatter ->
  'a t ->
  unit