Index of values


A
add [OptParse.OptParser]
Add an option to the option parser.
add_group [OptParse.OptParser]
Add a group to the option parser.
append [Enum]
append e1 e2 returns an enumeration that will enumerate over all elements of e1 followed by all elements of e2.

C
callback_option [OptParse.Opt]
Make a callback option which takes a single argument.
char_of [UChar]
char_of u returns the Latin-1 representation of u.
chr [UChar]
code n returns the Unicode character with the code number n.
chr_of_uint [UChar]
chr_of_uint n returns the Unicode character of the code number n.
clone [Enum]
clone e creates a new enumeration that is copy of e.
code [UChar]
code u returns the Unicode code number of u.
compare [UChar]
compare u1 u2 returns, a value > 0 if u1 has a larger Unicode code number than u2, 0 if u1 and u2 are the same Unicode character, a value < 0 if u1 has a smaller Unicode code number than u2.
concat [Enum]
concat e returns an enumeration over all elements of all enumerations of e.
count [Enum]
count e returns the number of remaining elements in e without consuming the enumeration.
count_option [OptParse.StdOpt]
Create a counting option which increments its value each time the option is encountered on the command line.

D
decr_option [OptParse.StdOpt]
Exactly identical to count_option ~dest:dest ~increment:(-1) ().
default [Option]
default x (Some v) returns v and default x None returns x.

E
empty [Global]
Returns an new named empty global.
empty [Enum]
The empty enumeration : contains no element
eq [UChar]
Equality by code point comparison
error [OptParse.OptParser]
Display an error message and exit the program.

F
fast_count [Enum]
For users worried about the speed of count you can call the fast_count function that will give an hint about count implementation.
fill [OptParse.Formatter]
filter [Enum]
filter f e returns an enumeration over all elements x of e such as f x returns true.
filter_map [Enum]
filter_map f e returns an enumeration over all elements x such as f y returns Some x , where y is an element of e.
find [Enum]
find f e returns the first element x of e such that f x returns true, consuming the enumeration up to and including the found element, or, raises Not_found if no such element exists in the enumeration, consuming the whole enumeration in the search.
float_callback [OptParse.StdOpt]
float_option [OptParse.StdOpt]
fold [Enum]
fold f v e returns v if e is empty, otherwise f (... (f (f v a1) a2) ...) aN where a1..N are the elements of e.
fold2 [Enum]
fold2 is similar to fold but will fold over two enumerations at the same time until one of the two enumerations ends.
fold2i [Enum]
foldi [Enum]
force [Enum]
force e forces the application of all lazy functions and the enumeration of all elements, exhausting the enumeration.
from [Enum]
from next creates an enumeration from the next function.

G
get [Option]
get (Some x) returns x and get None raises No_value.
get [OptParse.Opt]
Get the value of an option.
get [Global]
Get the global value contents - raise Global_not_initialized if not defined.
get [Enum]
get e returns None if e is empty or Some x where x is the next element of e, in which case the element is removed from the enumeration.

H
help_option [OptParse.StdOpt]
help_option () returns the standard help option which displays a usage message and exits the program when encountered on the command line.

I
incr_option [OptParse.StdOpt]
Exactly identical to count_option ~dest:dest ~increment:1 ().
indented_formatter [OptParse.Formatter]
Create an "indented" formatter with the given options.
init [Enum]
init n f creates a new enumeration over elements f 0, f 1, ..., f (n-1)
int_callback [OptParse.StdOpt]
int_callback ?metavar f returns an option which takes a single integer argument and calls f with that argument when encountered on the command line.
int_of_uchar [UChar]
Alias of uint_code
int_option [OptParse.StdOpt]
int_option ?default ?metavar () returns an option which takes a single integer argument.
is_empty [Enum]
is_empty e returns true if e does not contains any element.
is_none [Option]
is_none None returns true otherwise it returns false.
is_set [OptParse.Opt]
Find out if the option has a value (either by default or from the command line).
is_some [Option]
is_some (Some x) returns true otherwise it returns false.
isdef [Global]
Return true if the global value has been set.
iter [Enum]
iter f e calls the function f with each elements of e in turn.
iter2 [Enum]
iter2 f e1 e2 calls the function f with the next elements of e and e2 repeatedly until one of the two enumerations ends.
iter2i [Enum]
iteri [Enum]

J
junk [Enum]
junk e removes the first element from the enumeration, if any.

M
make [OptParse.OptParser]
Creates a new option parser with the given options.
make [Enum]
This function creates a fully defined enumeration.
map [Option]
map f (Some x) returns Some (f x) and map None returns None.
map [Enum]
map f e returns an enumeration over (f a1, f a2, ... , f aN) where a1...N are the elements of e.
map_default [Option]
map_default f x (Some v) returns f v and map_default f x None returns x.
mapi [Enum]
mapi is similar to map except that f is passed one extra argument which is the index of the element in the enumeration, starting from 0.
may [Option]
may f (Some x) calls f x and may f None does nothing.

N
name [Global]
Retrieve the name of a global.

O
of_char [UChar]
of_char c returns the Unicode character of the Latin-1 character c
opt [OptParse.Opt]
Get the value of an option as an optional value.
opt [Global]
Return None if the global is undefined, else Some v where v is the current global value contents.

P
parse [OptParse.OptParser]
Parse arguments as if the arguments args.(first), args.(first+1), ..., args.(last) had been given on the command line.
parse_argv [OptParse.OptParser]
Parse all the arguments in Sys.argv.
peek [Enum]
peek e returns None if e is empty or Some x where x is the next element of e.
push [Enum]
push e x will add x at the beginning of e.

S
set [OptParse.Opt]
Set the value of an option.
set [Global]
Set the global value contents.
store_const [OptParse.StdOpt]
store_const ?default const returns a flag option which stores the constant value const when the option is encountered on the command line.
store_false [OptParse.StdOpt]
store_false () returns an option which is set to false when it is encountered on the command line.
store_true [OptParse.StdOpt]
store_true () returns an option which is set to true when it is encountered on the command line.
str_callback [OptParse.StdOpt]
str_option [OptParse.StdOpt]

T
titled_formatter [OptParse.Formatter]
Creates a titled formatter which is quite similar to the indented formatter.

U
uchar_of_int [UChar]
Alias of chr_of_uint
uint_code [UChar]
uint_code u returns the Unicode code number of u.
undef [Global]
Reset the global value contents to undefined.
unsafe_chr_of_uint [UChar]
Unsafe version of UChar.chr_of_uint.
usage [OptParse.OptParser]
Display the usage message to the channel chn (default is Pervasives.stdout) and return.

V
value_option [OptParse.Opt]
Make an option which takes a single argument.
version_option [OptParse.StdOpt]
version_option f returns the standard version option which displays the string returned by f () (and nothing else) on standard output and exits.

W
wrap [OptParse.Formatter]
wrap text width reflows the given text paragraph into lines of width at most width (lines may exceed this if the are single words that exceed this limit).