Index of values


(^) [Astring]

A
append [Astring.String.Sub]
append s s' is like Astring.String.append.
append [Astring.String]
append s s' appends s' to s.

B
base [Astring.String.Sub]
base s is a substring that spans the whole base string of s.
base_string [Astring.String.Sub]
base_string s is s's base string.

C
capitalize [Astring.String.Ascii]
capitalize s is like Astring.String.Ascii.uppercase but performs the map only on s.[0].
choose [Astring.String.Map]
Exception safe Map.S.choose.
choose [Astring.String.Set]
Exception safe Set.S.choose.
compare [Astring.String.Sub]
compare s s' compares the positions of s and s' in lexicographical order.
compare [Astring.String]
compare s s' is Pervasives.compare s s', it compares the byte sequences of s and s' in lexicographical order.
compare [Astring.Char]
compare b b' is Pervasives.compare b b'.
compare_bytes [Astring.String.Sub]
compare_bytes s s' compares the bytes of s and s' in lexicographical order.
concat [Astring.String.Sub]
concat ~sep ss is like Astring.String.concat.
concat [Astring.String]
concat ~sep ss concatenates the list of strings ss, separating each consecutive elements in the list ss with sep (defaults to Astring.String.empty).
cut [Astring.String.Sub]
cut is like Astring.String.cut.
cut [Astring.String]
cut ~sep s is either the pair Some (l,r) of the two (possibly empty) substrings of s that are delimited by the first match of the non empty separator string sep or None if sep can't be matched in s.
cuts [Astring.String.Sub]
cuts is like Astring.String.cuts.
cuts [Astring.String]
cuts sep s is the list of all substrings of s that are delimited by matches of the non empty separator string sep.

D
dom [Astring.String.Map]
dom m is the domain of m.
drop [Astring.String.Sub]
drop is like Astring.String.drop.
drop [Astring.String]
drop ~rev ~min ~max ~sat s is the remaining span of Astring.String.span without the matching span.
dump [Astring.String.Map]
dump pp_v ppf m prints an unspecified representation of m on ppf using pp_v to print the map codomain elements.
dump [Astring.String.Set]
dump ppf ss prints an unspecified representation of ss on ppf.
dump [Astring.String.Sub]
dump ppf s prints s as a syntactically valid OCaml string on ppf using Astring.String.Ascii.escape_string.
dump [Astring.String]
dump ppf s prints s as a syntactically valid OCaml string on ppf using Astring.String.Ascii.escape_string.
dump [Astring.Char]
dump ppf c prints c as a syntactically valid OCaml char on ppf using Astring.Char.Ascii.escape_char
dump_raw [Astring.String.Sub]
dump_raw ppf s prints an unspecified raw internal representation of s on ppf.
dump_string_map [Astring.String.Map]
dump_string_map ppf m prints an unspecified representation of the string map m on ppf.

E
empty [Astring.String.Sub]
empty is the empty substring of the empty string Astring.String.empty.
empty [Astring.String]
empty is an empty string.
equal [Astring.String.Sub]
equal s s' is true iff s and s' have the same positions.
equal [Astring.String]
equal s s' is s = s'.
equal [Astring.Char]
equal b b' is b = b'.
equal_bytes [Astring.String.Sub]
equal_bytes s s' is true iff the substrings s and s' have exactly the same bytes.
escape [Astring.String.Ascii]
escape s is s with: Any '\\' (0x5C) escaped to the sequence "\\\\" (0x5C,0x5C)., Any byte in the ranges [0x00;0x1F] and [0x7F;0xFF] escaped by an hexadecimal "\xHH" escape with H a capital hexadecimal number. These bytes are the US-ASCII control characters and non US-ASCII bytes., Any other byte is left unchanged.
escape [Astring.Char.Ascii]
escape c escapes c with: '\\' (0x5C) escaped to the sequence "\\\\" (0x5C,0x5C)., Any byte in the ranges [0x00;0x1F] and [0x7F;0xFF] escaped by an hexadecimal "\xHH" escape with H a capital hexadecimal number. These bytes are the US-ASCII control characters and non US-ASCII bytes., Any other byte is left unchanged.
escape_char [Astring.Char.Ascii]
escape_char c is like Astring.Char.Ascii.escape except is escapes s according to OCaml's lexical conventions for characters with: '\b' (0x08) escaped to the sequence "\\b" (0x5C,0x62)., '\t' (0x09) escaped to the sequence "\\t" (0x5C,0x74)., '\n' (0x0A) escaped to the sequence "\\n" (0x5C,0x6E)., '\r' (0x0D) escaped to the sequence "\\r" (0x5C,0x72)., '\\'' (0x27) escaped to the sequence "\\'" (0x5C,0x27)., Other bytes follow the rules of Astring.Char.Ascii.escape
escape_string [Astring.String.Ascii]
escape_string s is like Astring.String.Ascii.escape except it escapes s according to OCaml's lexical conventions for strings with: Any '\b' (0x08) escaped to the sequence "\\b" (0x5C,0x62)., Any '\t' (0x09) escaped to the sequence "\\t" (0x5C,0x74)., Any '\n' (0x0A) escaped to the sequence "\\n" (0x5C,0x6E)., Any '\r' (0x0D) escaped to the sequence "\\r" (0x5C,0x72)., Any '\"' (0x22) escaped to the sequence "\\\"" (0x5C,0x22)., Any other byte follows the rules of Astring.String.Ascii.escape
exists [Astring.String.Sub]
exists is like Astring.String.exists on the substring.
exists [Astring.String]
exists p s is true iff there exists an index i of s with p s.[i] = true.
extend [Astring.String.Sub]
extend ~rev ~max ~sat s extends s by at most max consecutive sat satisfiying bytes of the base string located after stop s (rev is false, default) or before start s (rev is true).
extent [Astring.String.Sub]
extent s s' is the smallest substring that includes all the positions of s and s'.

F
fields [Astring.String.Sub]
fields is like Astring.String.fields.
fields [Astring.String]
fields ~empty ~is_sep s is the list of (possibly empty) substrings that are delimited by bytes for which is_sep is true.
filter [Astring.String.Sub]
filter sat s is like Astring.String.filter.
filter [Astring.String]
filter sat s is the string made of the bytes of s that satisfy sat, in the same order.
filter_map [Astring.String.Sub]
filter_map f s is like Astring.String.filter_map.
filter_map [Astring.String]
filter_map f s is the string made of the bytes of s as mapped by f, in the same order.
find [Astring.String.Map]
Exception safe Map.S.find.
find [Astring.String.Set]
Exception safe Set.S.find.
find [Astring.String.Sub]
find ~rev sat s is the substring of s (if any) that spans the first byte that satisfies sat in s after position start s (rev is false, default) or before stop s (rev is true).
find [Astring.String]
find ~rev ~start sat s is: If rev is false (default). The smallest index i, if any, greater or equal to start such that sat s.[i] is true. start defaults to 0., If rev is true. The greatest index i, if any, smaller or equal to start such that sat s.[i] is true. start defaults to String.length s - 1. Note that start can be any integer.
find_sub [Astring.String.Sub]
find_sub ~rev ~sub s is the substring of s (if any) that spans the first match of sub in s after position start s (rev is false, defaults) or before stop s (rev is false).
find_sub [Astring.String]
find_sub ~rev ~start ~sub s is: If rev is false (default). The smallest index i, if any, greater or equal to start such that sub can be found starting at i in s that is s.[i] = sub.[0], s.[i+1] = sub.[1], ... start defaults to 0., If rev is true. The greatest index i, if any, smaller or equal to start such that sub can be found starting at i in s that is s.[i] = sub.[0], s.[i+1] = sub.[1], ... start defaults to String.length s - 1. Note that start can be any integer.
fold_left [Astring.String.Sub]
fold_left is like Astring.String.fold_left.
fold_left [Astring.String]
fold_left f acc s is f (...
fold_right [Astring.String.Sub]
fold_right is like Astring.String.fold_right.
fold_right [Astring.String]
fold_right f s acc is f s.[0] (f s.[1] (...
for_all [Astring.String.Sub]
for_all is like Astring.String.for_all on the substring.
for_all [Astring.String]
for_all p s is true iff for all indices i of s, p s.[i] = true.

G
get [Astring.String.Map]
get k m is like Map.S.find but raises Invalid_argument if k is not bound in m.
get [Astring.String.Set]
get is like Set.S.find but
get [Astring.String.Sub]
get s i is the byte of s at its zero-based index i.
get [Astring.String]
get s i is the byte of s' at index i.
get_any_binding [Astring.String.Map]
get_any_binding is like Astring.String.Map.choose but
get_any_elt [Astring.String.Set]
get_any_elt is like Astring.String.Set.choose but
get_byte [Astring.String.Sub]
get_byte s i is Char.to_int (get s i).
get_byte [Astring.String]
get_byte s i is Char.to_int (get s i)
get_head [Astring.String.Sub]
get_head s is like Astring.String.Sub.head but
get_head [Astring.String]
get_head s is like Astring.String.head but
get_max_binding [Astring.String.Map]
get_max_binding is like Astring.String.Map.max_binding but
get_max_elt [Astring.String.Set]
get_max_elt is like Astring.String.Set.max_elt but
get_min_binding [Astring.String.Map]
get_min_binding is like Astring.String.Map.min_binding but
get_min_elt [Astring.String.Set]
get_min_elt is like Astring.String.Set.min_elt but

H
hash [Astring.String.Sub]
hash s is Hashtbl.hash s.
hash [Astring.String]
hash s is Hashtbl.hash s.
hash [Astring.Char]
hash is Hashtbl.hash.
head [Astring.String.Sub]
head s is Some (get s h) with h = 0 if rev = false (default) or h = length s - 1 if rev = true.
head [Astring.String]
head s is Some (get s h) with h = 0 if rev = false (default) or h = length s - 1 if rev = true.

I
is_alphanum [Astring.Char.Ascii]
is_alphanum c is is_letter c || is_digit c.
is_blank [Astring.Char.Ascii]
is_blank c is true iff c is an US-ASCII blank character, that is either space ' ' (0x20) or tab '\t' (0x09).
is_control [Astring.Char.Ascii]
is_control c is true iff c is an US-ASCII control character, that is a byte in the range [0x00;0x1F] or 0x7F.
is_digit [Astring.Char.Ascii]
is_digit c is true iff c is an US-ASCII digit '0' ...
is_empty [Astring.String.Sub]
is_empty s is length s = 0.
is_empty [Astring.String]
is_empty s is length s = 0.
is_graphic [Astring.Char.Ascii]
is_graphic c is true iff c is an US-ASCII graphic character that is a byte in the range [0x21;0x7E].
is_hex_digit [Astring.Char.Ascii]
is_hex_digit c is true iff c is an US-ASCII hexadecimal digit '0' ...
is_infix [Astring.String.Sub]
is_infix is like Astring.String.is_infix.
is_infix [Astring.String]
is_infix ~affix s is true iff there exists an index j in s such that for all indices i of affix we have affix.[i] = s.[j + i].
is_letter [Astring.Char.Ascii]
is_letter c is is_lower c || is_upper c.
is_lower [Astring.Char.Ascii]
is_lower c is true iff c is an US-ASCII lowercase letter 'a' ...
is_prefix [Astring.String.Sub]
is_prefix is like Astring.String.is_prefix.
is_prefix [Astring.String]
is_prefix ~affix s is true iff affix.[i] = s.[i] for all indices i of affix.
is_print [Astring.Char.Ascii]
is_print c is is_graphic c || c = ' '.
is_suffix [Astring.String.Sub]
is_suffix is like Astring.String.is_suffix.
is_suffix [Astring.String]
is_suffix ~affix s is true iff affix.[n - i] = s.[m - i] for all indices i of affix with n = String.length affix - 1 and m = String.length s - 1.
is_upper [Astring.Char.Ascii]
is_upper c is true iff c is an US-ASCII uppercase letter 'A' ...
is_valid [Astring.String.Ascii]
is_valid s is true iff only for all indices i of s, s.[i] is an US-ASCII character, i.e.
is_valid [Astring.Char.Ascii]
is_valid c is true iff c is an US-ASCII character, that is a byte in the range [0x00;0x7F].
is_white [Astring.Char.Ascii]
is_white c is true iff c is an US-ASCII white space character, that is one of space ' ' (0x20), tab '\t' (0x09), newline '\n' (0x0A), vertical tab (0x0B), form feed (0x0C), carriage return '\r' (0x0D).
iter [Astring.String.Sub]
iter is like Astring.String.iter.
iter [Astring.String]
iter f s is f s.[0]; f s.[1]; ...
iteri [Astring.String.Sub]
iteri is like Astring.String.iteri.
iteri [Astring.String]
iteri f s is f 0 s.[0]; f 1 s.[1]; ...

L
length [Astring.String.Sub]
length s is the number of bytes in s.
length [Astring.String]
length s is the number of bytes in s.
lowercase [Astring.String.Ascii]
lowercase s is s with US-ASCII characters 'A' to 'Z' mapped to 'a' to 'z'.
lowercase [Astring.Char.Ascii]
lowercase c is c with US-ASCII characters 'A' to 'Z' mapped to 'a' to 'z'.

M
map [Astring.String.Sub]
map is like Astring.String.map.
map [Astring.String]
map f s is s' with s'.[i] = f s.[i] for all indices i of s.
mapi [Astring.String.Sub]
mapi is like Astring.String.mapi.
mapi [Astring.String]
mapi f s is s' with s'.[i] = f i s.[i] for all indices i of s.
max_binding [Astring.String.Map]
Exception safe Map.S.max_binding.
max_elt [Astring.String.Set]
Exception safe Set.S.max_elt.
min_binding [Astring.String.Map]
Exception safe Map.S.min_binding.
min_elt [Astring.String.Set]
Exception safe Set.S.min_elt.

O
of_bool [Astring.String.Sub]
of_bool b is a string representation for b.
of_bool [Astring.String]
of_bool b is a string representation for b.
of_byte [Astring.Char]
of_byte b is a byte from b.
of_char [Astring.String.Sub]
of_char c is a string that contains the byte c.
of_char [Astring.String]
of_char c is a string that contains the byte c.
of_float [Astring.String.Sub]
of_float f is a string representation for f.
of_float [Astring.String]
of_float f is a string representation for f.
of_int [Astring.String.Sub]
of_int i is a string representation for i.
of_int [Astring.String]
of_int i is a string representation for i.
of_int [Astring.Char]
of_int b is a byte from b.
of_int32 [Astring.String.Sub]
of_int32 i is a string representation for i.
of_int32 [Astring.String]
of_int32 i is a string representation for i.
of_int64 [Astring.String.Sub]
of_int64 i is a string representation for i.
of_int64 [Astring.String]
of_int64 i is a string representation for i.
of_list [Astring.String.Map]
of_list bs is List.fold_left (fun m (k, v) -> add k v m) empty bs.
of_list [Astring.String.Set]
of_list ss is a set from the list ss.
of_nativeint [Astring.String.Sub]
of_nativeint i is a string representation for i.
of_nativeint [Astring.String]
of_nativeint i is a string representation for i.
of_string [Astring.String.Sub]
of_string s is v s
overlap [Astring.String.Sub]
overlap s s' is the smallest substring that includes all the positions common to s and s' or None if there are no such positions.

P
pp [Astring.String.Map]
pp ~sep pp_binding ppf m formats the bindings of m on ppf.
pp [Astring.String.Set]
pp ~sep pp_elt ppf ss formats the elements of ss on ppf.
pp [Astring.String.Sub]
pp ppf s prints s's bytes on ppf.
pp [Astring.String]
pp ppf s prints s's bytes on ppf.
pp [Astring.Char]
pp ppf c prints c on ppf.

R
rebase [Astring.String.Sub]
rebase s is v (to_string s).
reduce [Astring.String.Sub]
reduce ~rev ~max ~sat s reduces s by at most max consecutive sat satisfying bytes of s located before stop s (rev is false, default) or after start s (rev is true).

S
same_base [Astring.String.Sub]
same_base s s' is true iff the substrings s and s' have the same base string according to physical equality.
span [Astring.String.Sub]
span is like Astring.String.span.
span [Astring.String]
span ~rev ~min ~max ~sat s is (l, r) where: if rev is false (default), l is at least min and at most max consecutive sat satisfying initial bytes of s or Astring.String.empty if there are no such bytes. r are the remaining bytes of s., if rev is true, r is at least min and at most max consecutive sat satisfying final bytes of s or Astring.String.empty if there are no such bytes. l are the remaining the bytes of s. If max is unspecified the span is unlimited.
start [Astring.String.Sub]
start s is the empty substring at the start position of s.
start_pos [Astring.String.Sub]
start_pos s is s's start position in the base string.
stop [Astring.String.Sub]
stop s is the empty substring at the stop position of s.
stop_pos [Astring.String.Sub]
stop_pos s is s's stop position in the base string.
strf [Astring]
strf is Format.asprintf.
sub [Astring.String]
sub_with_index_range [Astring.String]
sub_with_index_range is like Astring.String.with_index_range but returns a substring value.
sub_with_range [Astring.String]
sub_with_range is like Astring.String.with_range but returns a substring value.

T
tail [Astring.String.Sub]
tail s is s without its first (rev is false, default) or last (rev is true) byte or s if it is empty.
take [Astring.String.Sub]
take is like Astring.String.take.
take [Astring.String]
take ~rev ~min ~max ~sat s is the matching span of Astring.String.span without the remaining one.
to_bool [Astring.String.Sub]
to_bool s is a bool from s, if any.
to_bool [Astring.String]
to_bool s is a bool from s, if any.
to_char [Astring.String.Sub]
to_char s is the single byte in s or None if there is no byte or more than one in s.
to_char [Astring.String]
to_char s is the single byte in s or None if there is no byte or more than one in s.
to_float [Astring.String.Sub]
to_float s is a float from s, if any.
to_float [Astring.String]
to_float s is a float from s, if any.
to_int [Astring.String.Sub]
to_int is an int from s, if any.
to_int [Astring.String]
to_int is an int from s, if any.
to_int [Astring.Char]
to_int b is the byte b as an integer.
to_int32 [Astring.String.Sub]
to_int32 is an int32 from s, if any.
to_int32 [Astring.String]
to_int32 is an int32 from s, if any.
to_int64 [Astring.String.Sub]
to_int64 is an int64 from s, if any.
to_int64 [Astring.String]
to_int64 is an int64 from s, if any.
to_nativeint [Astring.String.Sub]
to_nativeint is an nativeint from s, if any.
to_nativeint [Astring.String]
to_nativeint is an nativeint from s, if any.
to_string [Astring.String.Sub]
to_string s is the bytes of s as a string.
trim [Astring.String.Sub]
trim is like Astring.String.trim.
trim [Astring.String]
trim ~drop s is s with prefix and suffix bytes satisfying drop in s removed.

U
uncapitalize [Astring.String.Ascii]
uncapitalize s is like Astring.String.Ascii.lowercase but performs the map only on s.[0].
unescape [Astring.String.Ascii]
unescape s unescapes what Astring.String.Ascii.escape did.
unescape_string [Astring.String.Ascii]
unescape_string is to Astring.String.Ascii.escape_string what Astring.String.Ascii.unescape is to Astring.String.Ascii.escape and also additionally unescapes the sequence "\\'" (0x5C,0x27) to "'" (0x27).
uniquify [Astring.String]
uniquify ss is ss without duplicates, the list order is preserved.
uppercase [Astring.String.Ascii]
uppercase s is s with US-ASCII characters 'a' to 'z' mapped to 'A' to 'Z'.
uppercase [Astring.Char.Ascii]
uppercase c is c with US-ASCII characters 'a' to 'z' mapped to 'A' to 'Z'.

V
v [Astring.String.Sub]
v ~start ~stop s is the substring of s that starts at position start (defaults to 0) and stops at position stop (defaults to String.length s).
v [Astring.String]
v len f is a string s of length len with s.[i] = f i for all indices i of s.

W
with_index_range [Astring.String.Sub]
with_index_range is like Astring.String.sub_with_index_range.
with_index_range [Astring.String]
with_index_range ~first ~last s are the consecutive bytes of s whose indices exist in the range [first;last].
with_range [Astring.String.Sub]
with_range is like Astring.String.sub_with_range.
with_range [Astring.String]
with_range ~first ~len s are the consecutive bytes of s whose indices exist in the range [first;first + len - 1].