Source file stdcompat__option_s.ml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
module type S = sig

type 'a t = 'a option =
  | None 
  | Some of 'a 

(*
type 'a t = 'a option =
  | None 
  | Some of 'a 
*)
(** @since 4.08.0: type 'a t = 'a option =
                     | None 
                     | Some of 'a 
 *)

val none : 'a option
(** @since 4.08.0: val none : 'a option *)

val some : 'a -> 'a option
(** @since 4.08.0: val some : 'a -> 'a option *)

val value : 'a option -> default:'a -> 'a
(** @since 4.08.0: val value : 'a option -> default:'a -> 'a *)

val get : 'a option -> 'a
(** @since 4.08.0: val get : 'a option -> 'a *)

val bind : 'a option -> ('a -> 'b option) -> 'b option
(** @since 4.08.0: val bind : 'a option -> ('a -> 'b option) -> 'b option *)

val join : 'a option option -> 'a option
(** @since 4.08.0: val join : 'a option option -> 'a option *)

val map : ('a -> 'b) -> 'a option -> 'b option
(** @since 4.08.0: val map : ('a -> 'b) -> 'a option -> 'b option *)

val fold : none:'a -> some:('b -> 'a) -> 'b option -> 'a
(** @since 4.08.0: val fold : none:'a -> some:('b -> 'a) -> 'b option -> 'a *)

val iter : ('a -> unit) -> 'a option -> unit
(** @since 4.08.0: val iter : ('a -> unit) -> 'a option -> unit *)

val is_none : 'a option -> bool
(** @since 4.08.0: val is_none : 'a option -> bool *)

val is_some : 'a option -> bool
(** @since 4.08.0: val is_some : 'a option -> bool *)

val equal : ('a -> 'a -> bool) -> 'a option -> 'a option -> bool
(** @since 4.08.0:
    val equal : ('a -> 'a -> bool) -> 'a option -> 'a option -> bool *)

val compare : ('a -> 'a -> int) -> 'a option -> 'a option -> int
(** @since 4.08.0:
    val compare : ('a -> 'a -> int) -> 'a option -> 'a option -> int *)


val to_result : none:'e -> 'a option -> ('a, 'e) result

(*
val to_result : none:'e -> 'a option -> ('a, 'e) Stdcompat__pervasives.result
*)
(** @since 4.08.0: val to_result : none:'e -> 'a option -> ('a, 'e) result
 *)

val to_list : 'a option -> 'a list
(** @since 4.08.0: val to_list : 'a option -> 'a list *)


val to_seq : 'a option -> 'a Seq.t

(*
val to_seq : 'a option -> 'a Stdcompat__seq.t
*)
(** @since 4.08.0: val to_seq : 'a option -> 'a Seq.t
 *)

end