package frama-c

You can search for identifiers within the package.

in-package search v0.2.0

Platform dedicated to the analysis of source code written in C

Install

Dune Dependency

frama-c.com Readme Edit opam file Versions (25)

Authors

Maintainers

F

frama-ci-bot@frama-c.com

Sources

frama-c-31.0-Gallium.tar.gz

sha256=a94384f00d53791cbb4b4d83ab41607bc71962d42461f02d71116c4ff6dca567

doc/frama-c.kernel/Frama_c_kernel/Result/index.html

Module `Frama_c_kernel.Result`

Adding let binding operators to the Result module.

see https://v2.ocaml.org/manual/bindingops.html
This module does not use the generic monad interface (cf. Monad) because of the error type, which would require another layer of functors.

include module type of Stdlib.Result

type (!'a, !'e) t = ('a, 'e) Stdlib.result =

| Ok of 'a
| Error of 'e

val ok : 'a -> ('a, 'e) Stdlib.result

val error : 'e -> ('a, 'e) Stdlib.result

val value : ('a, 'e) Stdlib.result -> default:'a -> 'a

val get_ok : ('a, 'e) Stdlib.result -> 'a

val get_error : ('a, 'e) Stdlib.result -> 'e

val bind : 
  ('a, 'e) Stdlib.result ->
  ('a -> ('b, 'e) Stdlib.result) ->
  ('b, 'e) Stdlib.result

val join : (('a, 'e) Stdlib.result, 'e) Stdlib.result -> ('a, 'e) Stdlib.result

val map : ('a -> 'b) -> ('a, 'e) Stdlib.result -> ('b, 'e) Stdlib.result

val map_error : ('e -> 'f) -> ('a, 'e) Stdlib.result -> ('a, 'f) Stdlib.result

val fold : ok:('a -> 'c) -> error:('e -> 'c) -> ('a, 'e) Stdlib.result -> 'c

val iter : ('a -> unit) -> ('a, 'e) Stdlib.result -> unit

val iter_error : ('e -> unit) -> ('a, 'e) Stdlib.result -> unit

val is_ok : ('a, 'e) Stdlib.result -> bool

val is_error : ('a, 'e) Stdlib.result -> bool

val equal : 
  ok:('a -> 'a -> bool) ->
  error:('e -> 'e -> bool) ->
  ('a, 'e) Stdlib.result ->
  ('a, 'e) Stdlib.result ->
  bool

val compare : 
  ok:('a -> 'a -> int) ->
  error:('e -> 'e -> int) ->
  ('a, 'e) Stdlib.result ->
  ('a, 'e) Stdlib.result ->
  int

val to_option : ('a, 'e) Stdlib.result -> 'a option

val to_list : ('a, 'e) Stdlib.result -> 'a list

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

val zip : 
  ('a, 'e) Stdlib.result ->
  ('b, 'e) Stdlib.result ->
  ('a * 'b, 'e) Stdlib.result

zip r1 r2 regroups values in a pair Ok (v1, v2) if both arguments are Ok v1 and Ok v2 and propagate errors in other cases. If both r1 and r2 are errors we keep the first one, in this case r1.

module Operators : sig ... end