Result (p.preface.0.1.0.doc.preface.stdlib.Preface

Result.t is like Either.t but it exist for semantic reasons. (Left and Right are not very specific on what are the valid and the invalid branch).

Type

Sourcetype ('a, 'b) t = ('a, 'b) result =

| Ok of 'a
| Error of 'b

Implementation

Bifunctor

module Bifunctor : Preface_specs.BIFUNCTOR with type ('a, 'b) t = ('a, 'b) t

Delayed implementation

By setting the error type of Result.t it is possible to get implementations for abstractions on constructors of type with an arity of 1.

Functor

Source

module Functor
  (T : Preface_specs.Types.T0) : 
  Preface_specs.FUNCTOR with type 'a t = ('a, T.t) Bifunctor.t

Alt

Source

module Alt
  (T : Preface_specs.Types.T0) : 
  Preface_specs.ALT with type 'a t = ('a, T.t) Bifunctor.t

Applicative

Result.t implements Preface_specs.APPLICATIVE and introduces an interface to define Preface_specs.TRAVERSABLE using Result as an iterable structure.

Source

module Applicative
  (T : Preface_specs.Types.T0) : 
  Preface_specs.Traversable.API_OVER_APPLICATIVE
    with type 'a t = ('a, T.t) Bifunctor.t

Monad

Result.t implements Preface_specs.MONAD and introduces an interface to define Preface_specs.TRAVERSABLE using Result as an iterable structure.

Source

module Monad
  (T : Preface_specs.Types.T0) : 
  Preface_specs.Traversable.API_OVER_MONAD
    with type 'a t = ('a, T.t) Bifunctor.t

Foldable

Source

module Foldable
  (T : Preface_specs.Types.T0) : 
  Preface_specs.FOLDABLE with type 'a t = ('a, T.t) Bifunctor.t

Addtional functions

Additional functions to facilitate practical work with Result.t.

Sourceval pure : 'a -> ('a, 'b) t

Create a value from 'b to ('a, 'b) t.

Source

val equal : 
  ('a -> 'a -> bool) ->
  ('b -> 'b -> bool) ->
  ('a, 'b) t ->
  ('a, 'b) t ->
  bool

Equality between Result.t.

Source

val pp : 
  (Format.formatter -> 'a -> unit) ->
  (Format.formatter -> 'b -> unit) ->
  Format.formatter ->
  ('a, 'b) t ->
  unit

Formatter for pretty-printing for Result.t.