Module String.Sub

The type for substrings.

empty is the empty substring of the empty string String.empty.

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).

raises Invalid_argument

if start or stop are not positions of s or if stop < start.

start_pos s is s's start position in the base string.

stop_pos s is s's stop position in the base string.

base_string s is s's base string.

length s is the number of bytes in s.

get s i is the byte of s at its zero-based index i.

raises Invalid_argument

if i is not an index of s.

get_byte s i is Char.to_int (get s i).

head s is Some (get s h) with h = 0 if rev = false (default) or h = length s - 1 if rev = true. None is returned if s is empty.

get_head s is like head but

raises Invalid_argument

if s is empty.

of_string s is v s

to_string s is the bytes of s as a string.

rebase s is v (to_string s). This puts s on a base string made solely of its bytes.

hash s is Hashtbl.hash s.

start s is the empty substring at the start position of s.

stop s is the empty substring at the stop position of s.

base s is a substring that spans the whole base string of s.

tail s is s without its first (rev is false, default) or last (rev is true) byte or s if it is empty.

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). If max is unspecified the extension is limited by the extents of the base string of s. sat defaults to fun _ -> true.

raises Invalid_argument

if max is negative.

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). If max is unspecified the reduction is limited by the extents of the substring s. sat defaults to fun _ -> true.

raises Invalid_argument

if max is negative.

extent s s' is the smallest substring that includes all the positions of s and s'.

raises Invalid_argument

if s and s' are not on the same base string according to physical equality.

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. Note that the overlap substring may be empty.

raises Invalid_argument

if s and s' are not on the same base string according to physical equality.

append s s' is like String:append. The substrings can be on different bases and the result is on a base string that holds exactly the appended bytes.

concat ~sep ss is like String.concat. The substrings can all be on different bases and the result is on a base string that holds exactly the concatenated bytes.

is_empty s is length s = 0.

is_prefix is like String.is_prefix. Only bytes are compared, affix can be on a different base string.

is_infix is like String.is_infix. Only bytes are compared, affix can be on a different base string.

is_suffix is like String.is_suffix. Only bytes are compared, affix can be on a different base string.

for_all is like String.for_all on the substring.

exists is like String.exists on the substring.

same_base s s' is true iff the substrings s and s' have the same base string according to physical equality.

equal_bytes s s' is true iff the substrings s and s' have exactly the same bytes. The substrings can be on a different base string.

compare_bytes s s' compares the bytes of s and s' in lexicographical order. The substrings can be on a different base string.

equal s s' is true iff s and s' have the same positions.

raises Invalid_argument

if s and s' are not on the same base string according to physical equality.

compare s s' compares the positions of s and s' in lexicographical order.

raises Invalid_argument

if s and s' are not on the same base string according to physical equality.

with_range is like String.sub_with_range. The indices are the substring's zero-based ones, not those in the base string.

with_index_range is like String.sub_with_index_range. The indices are the substring's zero-based ones, not those in the base string.

trim is like String.trim. If all bytes are dropped returns an empty string located in the middle of the argument.

span is like String.span. For a substring s a left empty span is start s and a right empty span is stop s.

take is like String.take.

drop is like String.drop.

cut is like String.cut. sep can be on a different base string

cuts is like String.cuts. sep can be on a different base string

fields is like String.fields.

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). None is returned if there is no matching byte in s.

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, default) or before stop s (rev is true). Only bytes are compared and sub can be on a different base string. None is returned if there is no match of sub in s.

filter sat s is like String.filter. The result is on a base string that holds only the filtered bytes.

filter_map f s is like String.filter_map. The result is on a base string that holds only the filtered bytes.

map is like String.map. The result is on a base string that holds only the mapped bytes.

mapi is like String.mapi. The result is on a base string that holds only the mapped bytes. The indices are the substring's zero-based ones, not those in the base string.

fold_left is like String.fold_left.

fold_right is like String.fold_right.

iter is like String.iter.

iteri is like String.iteri. The indices are the substring's zero-based ones, not those in the base string.

pp ppf s prints s's bytes on ppf.

dump ppf s prints s as a syntactically valid OCaml string on ppf using Ascii.escape_string.

dump_raw ppf s prints an unspecified raw internal representation of s on ppf.

of_char c is a string that contains the byte c.

to_char s is the single byte in s or None if there is no byte or more than one in s.

of_bool b is a string representation for b. Relies on Stdlib.string_of_bool.

to_bool s is a bool from s, if any. Relies on Stdlib.bool_of_string.

of_int i is a string representation for i. Relies on Stdlib.string_of_int.

to_int is an int from s, if any. Relies on Stdlib.int_of_string.

of_nativeint i is a string representation for i. Relies on Nativeint.of_string.

to_nativeint is an nativeint from s, if any. Relies on Nativeint.to_string.

of_int32 i is a string representation for i. Relies on Int32.of_string.

to_int32 is an int32 from s, if any. Relies on Int32.to_string.

of_int64 i is a string representation for i. Relies on Int64.of_string.

to_int64 is an int64 from s, if any. Relies on Int64.to_string.

of_float f is a string representation for f. Relies on Stdlib.string_of_float.

to_float s is a float from s, if any. Relies on Stdlib.float_of_string.