Index of values


B
bind [Api.OUTPUT_MODEL]
The monadic bind.
blit [Api.MINIMALISTIC_MUTABLE_STRING]
blit src src_pos dst dst_pos len copies len characters starting at src_pos of src into dst starting from dst_post.
blit [Api.UNSAFELY_MUTABLE]
Copy length characters from src (starting at src_index) to dst (starting at dst_index).
blit_exn [Api.UNSAFELY_MUTABLE]
Like Api.UNSAFELY_MUTABLE.blit but fail with a non-specified exception.

C
chop_prefix [Functors.Make_prefix_suffix_array]
chop_prefix [Api.BASIC_STRING]
Like chop_prefix_exn but return None instead of throwing an Invalid_argument.
chop_prefix_exn [Functors.Make_prefix_suffix_array]
chop_prefix_exn [Api.BASIC_STRING]
Return a copy of t with prefix removed from the beginning.
chop_suffix [Functors.Make_prefix_suffix_array]
chop_suffix [Api.BASIC_STRING]
Like chop_suffix_exn but return None instead of throwing an exception.
chop_suffix_exn [Functors.Make_prefix_suffix_array]
chop_suffix_exn [Api.BASIC_STRING]
Return a copy of t with suffix removed from the end.
compare [Functors.Make_native]
compare [Api.MINIMALISTIC_MUTABLE_STRING]
Comparison function for strings.
compare [Api.BASIC_STRING]
Comparison function (as expected by most common functors in the ecosystem).
compare [Api.BASIC_CHARACTER]
Comparison function (as expected by most common functors in the ecosystem).
compare_char [Api.MINIMALISTIC_MUTABLE_STRING]
Comparison function for characters.
compare_substring [Functors.T_LENGTH_AND_COMPSUB]
compare_substring [Functors.Make_native.T_length_and_compsub]
compare_substring [Functors.Make_native]
compare_substring [Api.BASIC_STRING]
Comparison function for substrings: use as compare_substring (s1, index1, length1) (s2, index2, length2).
compare_substring_strict [Functors.Compare_substring_strict_of_loose]
compare_substring_strict [Api.BASIC_STRING]
Like compare_substring but return Some _ only when it is well defined (same validity criteria as sub: if length is 0, index is irrelevant).
concat [Functors.Make_native]
concat [Api.BASIC_STRING]
The classical concat function.

D
drop [Functors.Make_split_at_index_functions]
drop [Api.BASIC_STRING]
Just the second part of split_at.

E
empty [Functors.T_LENGTH_SUB_AND_SEARCH_REV]
empty [Functors.Make_native]
empty [Api.MINIMALISTIC_MUTABLE_STRING]
A string of zero length
empty [Api.BASIC_STRING]
A string of zero length.
exists [Functors.Make_native]
exists [Api.BASIC_STRING]
Return true if-and-only-if f returns true on at least one character.

F
filter [Functors.Make_native]
filter [Api.BASIC_STRING]
Create a new string with the characters for which f c is true.
filter_map [Functors.Make_native]
filter_map [Api.BASIC_STRING]
Create a new string with the characters for which f c returned Some c.
find [Functors.Make_native]
find [Api.BASIC_STRING]
Find the index of the first character c for which f c is true.
find_reverse [Functors.Make_native]
find_reverse [Api.BASIC_STRING]
Find the index of the last character c for which f c is true.
fold [Functors.Make_native]
fold [Api.BASIC_STRING]
The standard fold function, see List.fold_left for example.
fold2_exn [Functors.Make_native]
fold2_exn [Api.BASIC_STRING]
The standard fold2 function, see List.fold_left2 for example.
foldi [Functors.Make_native]
foldi [Api.BASIC_STRING]
Pass an accumulator over the string's characters and their ordinals, starting with the first; left most.
for_all [Functors.Make_native]
for_all [Api.BASIC_STRING]
Return true if-and-only-if f returns true on all characters.

G
get [Functors.Make_native]
get [Api.MINIMALISTIC_MUTABLE_STRING]
Get the n-th char.
get [Api.BASIC_STRING]
Get the n-th char, indexes are not necessarily bytes, they can be bits.
get_exn [Functors.Make_native]
get_exn [Api.BASIC_STRING]
Like get but fail with an exception.

I
index_of_character [Functors.T_LENGTH_SUB_AND_SEARCH]
index_of_character [Functors.Make_native]
index_of_character [Api.BASIC_STRING]
Find the first occurrence of a character in the string (starting at position from).
index_of_character_reverse [Functors.T_LENGTH_SUB_AND_SEARCH_REV]
index_of_character_reverse [Functors.Make_native]
index_of_character_reverse [Api.BASIC_STRING]
Like index_of_character but start from the end of the string.
index_of_string [Functors.T_LENGTH_SUB_AND_SEARCH]
index_of_string [Functors.Make_index_of_string]
index_of_string [Api.BASIC_STRING]
Find the first occurrence of the substring (sub, sub_index, sub_length) in a given string, starting at from.
index_of_string_reverse [Functors.T_LENGTH_SUB_AND_SEARCH_REV]
index_of_string_reverse [Functors.Make_index_of_string]
index_of_string_reverse [Api.BASIC_STRING]
Like index_of_string but start from the end of the string.
is_empty [Functors.Make_native]
is_empty [Api.BASIC_STRING]
Test whether a string is empty.
is_prefix [Functors.Make_prefix_suffix_array]
is_prefix [Api.BASIC_STRING]
Does t start with prefix?
is_suffix [Functors.Make_prefix_suffix_array]
is_suffix [Api.BASIC_STRING]
Does t end with suffix?
is_whitespace [Api.MINIMALISTIC_MUTABLE_STRING]
Tell whether a character is considered whitespace.
is_whitespace [Api.BASIC_CHARACTER]
Tell whether a character is considered whitespace.
iter [Functors.Make_native]
iter [Api.BASIC_STRING]
Apply f on every character successively.
iter_reverse [Functors.Make_native]
iter_reverse [Api.BASIC_STRING]
Apply f on every character successively in reverse order.
iteri [Functors.Make_native]
iteri [Api.BASIC_STRING]
Apply f on every character and its index.

L
length [Functors.T_LENGTH_SUB_AND_SEARCH_REV]
length [Functors.T_LENGTH_SUB_AND_SEARCH]
length [Functors.T_LENGTH_AND_COMPSUB]
length [Functors.Make_native.T_length_and_compsub]
length [Functors.Make_native]
length [Api.MINIMALISTIC_MUTABLE_STRING]
Get the length of the string (i.e.
length [Api.BASIC_STRING]
Get the length of the string (i.e.

M
make [Functors.Make_native]
make [Api.MINIMALISTIC_MUTABLE_STRING]
make size char builds a new string of the passed length where the character at every position is char, like String.make.
make [Api.BASIC_STRING]
make size char builds a new string of the passed length where the character at every position is char, like String.make.
map [Functors.Make_native]
map [Api.BASIC_STRING]
Make a new string by applying f to all characters of the input.
map2_exn [Functors.Make_native]
map2_exn [Api.BASIC_STRING]
Make a new string by applying f to all pairs of characters of the inputs.
mapi [Functors.Make_native]
mapi [Api.BASIC_STRING]
Make a new string by applying f to all characters and their indices.
max_string_length [Functors.Make_native]
max_string_length [Api.MINIMALISTIC_MUTABLE_STRING]
If the representation of strings is bounded, the maximum length of a string.
max_string_length [Api.BASIC_STRING]
If the representation of strings is bounded (by a constant other than the process memory), the maximum length of a string is assumed to be this number of characters.
mutate [Api.UNSAFELY_MUTABLE]
Set the index-th character of the string.
mutate_exn [Api.UNSAFELY_MUTABLE]
Set the index-th character of the string, but fail with a non-specified exception.

O
of_character [Functors.Make_native]
of_character [Api.BASIC_STRING]
Make a string with one character.
of_character_list [Functors.Make_native]
of_character_list [Api.BASIC_STRING]
Make a string out of a list of characters.
of_int [Api.BASIC_CHARACTER]
Import an integer, returns None if there is no character for that value.
of_native_char [Api.BASIC_CHARACTER]
Import a native char, returns None if the character is not representable.
of_native_string [Api.NATIVE_CONVERSIONS]
Convert a native string to the current representation.
of_native_substring [Api.NATIVE_CONVERSIONS]
Convert a native string like of_native_string but take a subset of the string.
output [Functors.Make_native.Make_output]
output [Api.BASIC_STRING.Make_output]
Output a string to a channel.
output [Api.OUTPUT_MODEL]
The function to output a given native string to a channel.

R
read_from_native_string [Api.BASIC_CHARACTER]
Read a character at a given index in a native string, returns Some (c, s), the character c and the number of units read s, or None if there is no representable/valid character at that index.
resize_from_length [Functors.Make_native]
return [Api.OUTPUT_MODEL]
The monadic return.
rev [Functors.Make_native]
rev [Api.BASIC_STRING]
Reverse the string.

S
set [Functors.Make_native]
set [Api.MINIMALISTIC_MUTABLE_STRING]
Set the n-th char.
set [Api.BASIC_STRING]
set str ~index ~v creates a new string equal to t with character v at position index.
set_exn [Functors.Make_native]
set_exn [Api.BASIC_STRING]
Like set but fail with an exception.
size [Api.BASIC_CHARACTER]
Get the size of the character, the exact semantics are implementation-specific (c.f.
slice [Functors.Make_native]
slice [Api.BASIC_STRING]
Create a sub-string from start to just before finish if all of the indices are in bounds.
slice_exn [Functors.Make_native]
slice_exn [Api.BASIC_STRING]
Like slice but throw an exception instead of returning None if the indices are out of bounds.
split [Functors.Make_split_rev_function]
split [Functors.Make_split_function]
split [Api.BASIC_STRING]
Split the string using on as separator.
split_at [Functors.Make_split_at_index_functions]
split_at [Api.BASIC_STRING]
Return a tuple where the first string is a prefix of the specified length and the second is the rest.
strip [Functors.Make_strip_function]
strip [Api.BASIC_STRING]
Remove any whitespace characters at the beginning and/or the end of the string
sub [Functors.Make_native]
sub [Api.BASIC_STRING]
Get the sub-string of size length at position index.
sub_exn [Functors.T_LENGTH_SUB_AND_SEARCH_REV]
sub_exn [Functors.T_LENGTH_SUB_AND_SEARCH]
sub_exn [Functors.Make_native]
sub_exn [Api.BASIC_STRING]
Like sub but throw an exception instead of returning None.
sub_same_tl [Functors.Make_prefix_suffix_array]

T
take [Functors.Make_split_at_index_functions]
take [Api.BASIC_STRING]
Just the first part of split_at.
take_while [Functors.Make_native]
take_while [Api.BASIC_STRING]
Take a prefix of the string until f returns false.
take_while_with_index [Functors.Make_native]
take_while_with_index [Api.BASIC_STRING]
Like take_while but the function also takes the current index.
to_character_list [Functors.Make_native]
to_character_list [Api.BASIC_STRING]
Explode a string into a list of characters.
to_int [Api.BASIC_CHARACTER]
Returns the integer representation of the character.
to_native_string [Api.NATIVE_CONVERSIONS]
Serialize the string to a native string.
to_native_string [Api.BASIC_CHARACTER]
to_native_string c creates a string containing the serialization of the character c (if size c is not a multiple of 8, the end-padding is undefined).
to_string_hum [Api.BASIC_STRING]
Convert the string to a human-readable native string (à la sprintf "%S").
to_string_hum [Api.BASIC_CHARACTER]
Convert the character to a human-readable native string (in the spirit of sprintf "%s").

W
write_to_native_bytes [Api.BASIC_CHARACTER]
write_to_native_bytes c ~buf ~index serializes the character c at position index in the native bytes buf (writing size c units).