package climate

You can search for identifiers within the package.

in-package search v0.2.0

package climate

climate
- CHANGES
- README
- Library climate
  - Climate
    
    Arg_parser
    
    Completion
    
    Reentrant
    
    Private
    
    Help_style
    
    Manpage
    
    Eval_config
    
    Program_name
    
    Command
    
    For_test
    
    Climate_stdlib
    
    Result
    
    List
    
    O
    
    Option
    
    List
    
    Map
    
    OrderedType
    
    S
    
    Make
    
    Nonempty_list
    
    Nonnegative_int
    
    String
    
    Set
    
    Map
    
    Int
    
    Set
    
    Map
    
    Non_ret
    
    Parse_error
- Sources
  - climate
    
    ansi_style.ml
    
    arg_parser.ml
    
    built_in.ml
    
    climate.ml
    
    climate__.ml
    
    climate_stdlib.ml
    
    command_doc_spec.ml
    
    command_line.ml
    
    completion.ml
    
    completion_spec.ml
    
    error.ml
    
    help.ml
    
    import.ml
    
    manpage.ml
    
    name.ml
    
    non_ret.ml
    
    raw_arg_table.ml
    
    shell_dsl.ml
    
    spec.ml
    
    subcommand.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Climate_stdlib.Result`Source

include module type of Result

Results

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

| Ok of 'a
| 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 get_ok : ('a, 'e) result -> 'a

get_ok r is v if r is Ok v and raise otherwise.

raises Invalid_argument
if r is Error _.

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

get_error r is e if r is Error e and raise otherwise.

raises Invalid_argument
if r is Ok _.

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 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 _.

Source

val 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 _.

Source

val 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 map : ('a, 'error) t -> f:('a -> 'b) -> ('b, 'error) t

Sourceval map_error : ('a, 'error1) t -> f:('error1 -> 'error2) -> ('a, 'error2) t

Sourceval bind : ('a, 'error) t -> f:('a -> ('b, 'error) t) -> ('b, 'error) t

Sourcemodule List : sig ... end

Sourcemodule O : sig ... end

package climate

Module Climate_stdlib.ResultSource

Results

Predicates and comparisons

Converting

Module `Climate_stdlib.Result`Source