package stdcompat

You can search for identifiers within the package.

in-package search v0.2.0

package stdcompat

stdcompat
- Stdcompat
  - Arg
  - Array
  - ArrayLabels
  - Atomic
  - Bool
  - Buffer
  - Bytes
  - BytesLabels
  - Char
  - Digest
  - Either
  - Ephemeron
    
    K1
    
    Bucket
    
    Make
    
    H
    
    MakeSeeded
    
    H
    
    K2
    
    Bucket
    
    Make
    
    H1
    
    H2
    
    MakeSeeded
    
    H1
    
    H2
    
    Kn
    
    Bucket
    
    Make
    
    H
    
    MakeSeeded
    
    H
    
    S
    
    SeededS
  - Filename
  - Float
  - Format
  - Fun
  - Hashtbl
    
    S
    
    SeededHashedType
    
    SeededS
  - In_channel
  - Int
  - Int32
  - Int64
  - Lazy
  - Lexing
  - List
  - ListLabels
  - Map
    
    S
  - Nativeint
  - Option
  - Out_channel
  - Pervasives
  - Printexc
  - Printf
  - Queue
  - Random
    
    State
  - Result
  - Seq
  - Set
    
    S
  - Stack
  - StdLabels
    
    Array
    
    Bytes
    
    List
    
    String
  - Stdlib
    
    Arg
    
    Array
    
    ArrayLabels
    
    Atomic
    
    Bool
    
    Buffer
    
    Bytes
    
    BytesLabels
    
    Char
    
    Digest
    
    Either
    
    Ephemeron
    
    K1
    
    Bucket
    
    Make
    
    H
    
    MakeSeeded
    
    H
    
    K2
    
    Bucket
    
    Make
    
    H1
    
    H2
    
    MakeSeeded
    
    H1
    
    H2
    
    Kn
    
    Bucket
    
    Make
    
    H
    
    MakeSeeded
    
    H
    
    S
    
    SeededS
    
    Filename
    
    Float
    
    Format
    
    Fun
    
    Hashtbl
    
    S
    
    SeededHashedType
    
    SeededS
    
    In_channel
    
    Int
    
    Int32
    
    Int64
    
    Lazy
    
    Lexing
    
    List
    
    ListLabels
    
    Map
    
    S
    
    Nativeint
    
    Option
    
    Out_channel
    
    Pervasives
    
    Printexc
    
    Printf
    
    Queue
    
    Random
    
    State
    
    Result
    
    Seq
    
    Set
    
    S
    
    Stack
    
    StdLabels
    
    Array
    
    Bytes
    
    List
    
    String
    
    Stream
    
    String
    
    StringLabels
    
    Sys
    
    Uchar
    
    Unit
    
    Weak
  - Stream
  - String
  - StringLabels
  - Sys
  - Uchar
  - Unit
  - Weak

Legend:
Library
Module
Module type
Parameter
Class
Class type

include module type of struct include Either end

type ('a, 'b) t = ('a, 'b) Either.t =

| Left of 'a
| Right of 'b

A value of ('a, 'b) Either.t contains either a value of 'a or a value of 'b

val left : 'a -> ('a, 'b) t

left v is Left v.

val right : 'b -> ('a, 'b) t

right v is Right v.

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

is_left (Left v) is true, is_left (Right v) is false.

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

is_right (Left v) is false, is_right (Right v) is true.

val find_left : ('a, 'b) t -> 'a option

find_left (Left v) is Some v, find_left (Right _) is None

val find_right : ('a, 'b) t -> 'b option

find_right (Right v) is Some v, find_right (Left _) is None

val map_left : ('a1 -> 'a2) -> ('a1, 'b) t -> ('a2, 'b) t

map_left f e is Left (f v) if e is Left v and e if e is Right _.

val map_right : ('b1 -> 'b2) -> ('a, 'b1) t -> ('a, 'b2) t

map_right f e is Right (f v) if e is Right v and e if e is Left _.

val map : 
  left:('a1 -> 'a2) ->
  right:('b1 -> 'b2) ->
  ('a1, 'b1) t ->
  ('a2, 'b2) t

map ~left ~right (Left v) is Left (left v), map ~left ~right (Right v) is Right (right v).

val fold : left:('a -> 'c) -> right:('b -> 'c) -> ('a, 'b) t -> 'c

fold ~left ~right (Left v) is left v, and fold ~left ~right (Right v) is right v.

val iter : left:('a -> unit) -> right:('b -> unit) -> ('a, 'b) t -> unit

iter ~left ~right (Left v) is left v, and iter ~left ~right (Right v) is right v.

val for_all : left:('a -> bool) -> right:('b -> bool) -> ('a, 'b) t -> bool

for_all ~left ~right (Left v) is left v, and for_all ~left ~right (Right v) is right v.

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

equal ~left ~right e0 e1 tests equality of e0 and e1 using left and right to respectively compare values wrapped by Left _ and Right _.

val compare : 
  left:('a -> 'a -> int) ->
  right:('b -> 'b -> int) ->
  ('a, 'b) t ->
  ('a, 'b) t ->
  int

compare ~left ~right e0 e1 totally orders e0 and e1 using left and right to respectively compare values wrapped by Left _ and Right _. Left _ values are smaller than Right _ values.