package smtml

  1. Overview
  2. Docs
An SMT solver frontend for OCaml

Install 

dune-project
 Dependency

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

Authors

  1. J
    João Pereira <joaomhmpereira@tecnico.ulisboa.pt>
  2. F
    Filipe Marques <filipe.s.marques@tecnico.ulisboa.pt>
  3. H
    Hichem Rami Ait El Hara <hra@ocamlpro.com>
  4. L
    Léo Andrès <contact@ndrs.fr>
  5. A
    Arthur Carcano <arthur.carcano@ocamlpro.com>
  6. P
    Pierre Chambart <pierre.chambart@ocamlpro.com>
  7. J
    José Fragoso Santos <jose.fragoso@tecnico.ulisboa.pt>

Maintainers

  1. F
    Filipe Marques <filipe.s.marques@tecnico.ulisboa.pt>

Sources

v0.13.0.tar.gz
md5=3331d81d933a176492ff37e6e7a73e10
sha512=d0b51abea60fd83d0395a22fba32ad2cda63ffb294f7d9d1035c7cc37aa744bfd8e1ae95b07cc743ef8f29ca9ced109bb5a7805ecfda0187b24e90724ef92fc3

doc/smtml.prelude/Smtml_prelude/Result/index.html

Module Smtml_prelude.ResultSource

include module type of struct include Prelude.Result end
include module type of struct include Result end

Results

Sourcetype ('a, 'e) t = ('a, 'e) result =
  1. | Ok of 'a
  2. | Error of 'e

The type for result values. Either a value Ok v or an error Error e.

Sourceval ok : 'a -> ('a, 'e) result

ok v is Ok v.

Sourceval error : 'e -> ('a, 'e) result

error e is Error e.

Sourceval value : ('a, 'e) result -> default:'a -> 'a

value r ~default is v if r is Ok v and default otherwise.

Sourceval bind : ('a, 'e) result -> ('a -> ('b, 'e) result) -> ('b, 'e) result

bind r f is f v if r is Ok v and r if r is Error _.

Sourceval join : (('a, 'e) result, 'e) result -> ('a, 'e) result

join rr is r if rr is Ok r and rr if rr is Error _.

Sourceval map : ('a -> 'b) -> ('a, 'e) result -> ('b, 'e) result

map f r is Ok (f v) if r is Ok v and r if r is Error _.

Sourceval map_error : ('e -> 'f) -> ('a, 'e) result -> ('a, 'f) result

map_error f r is Error (f e) if r is Error e and r if r is Ok _.

Sourceval fold : ok:('a -> 'c) -> error:('e -> 'c) -> ('a, 'e) result -> 'c

fold ~ok ~error r is ok v if r is Ok v and error e if r is Error e.

Sourceval iter : ('a -> unit) -> ('a, 'e) result -> unit

iter f r is f v if r is Ok v and () otherwise.

Sourceval iter_error : ('e -> unit) -> ('a, 'e) result -> unit

iter_error f r is f e if r is Error e and () otherwise.

Predicates and comparisons

Sourceval is_ok : ('a, 'e) result -> bool

is_ok r is true if and only if r is Ok _.

Sourceval is_error : ('a, 'e) result -> bool

is_error r is true if and only if r is Error _.

Sourceval equal : ok:('a -> 'a -> bool) -> error:('e -> 'e -> bool) -> ('a, 'e) result -> ('a, 'e) result -> bool

equal ~ok ~error r0 r1 tests equality of r0 and r1 using ok and error to respectively compare values wrapped by Ok _ and Error _.

Sourceval compare : ok:('a -> 'a -> int) -> error:('e -> 'e -> int) -> ('a, 'e) result -> ('a, 'e) result -> int

compare ~ok ~error r0 r1 totally orders r0 and r1 using ok and error to respectively compare values wrapped by Ok _ and Error _. Ok _ values are smaller than Error _ values.

Converting

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

to_option r is r as an option, mapping Ok v to Some v and Error _ to None.

Sourceval to_list : ('a, 'e) result -> 'a list

to_list r is [v] if r is Ok v and [] otherwise.

Sourceval to_seq : ('a, 'e) result -> 'a Seq.t

to_seq r is r as a sequence. Ok v is the singleton sequence containing v and Error _ is the empty sequence.

Sourceval (let*) : ('a, 'b) result -> ('a -> ('c, 'b) result) -> ('c, 'b) result
Sourceval (let+) : ('a, 'b) result -> ('a -> 'c) -> ('c, 'b) result
Sourceval list_iter : ('a -> (unit, 'b) result) -> 'a list -> (unit, 'b) t
Sourceval list_map : ('a -> ('b, 'c) result) -> 'a list -> ('b list, 'c) t
Sourceval list_filter_map : ('a -> ('b option, 'c) result) -> 'a list -> ('b list, 'c) t