Module CCString Source Basic String Utils
Source type 'a iter = ('a -> -> Source type 'a gen = unit -> 'a option Source val make : int -> char -> stringmake n c is a string of length n with each index holding the character c.
Source val init : int -> (int -> char) -> init n f is a string of length n with index i holding the character f i (called in increasing index order).
Source val get : string -> int -> charget s i is the character at index i in s. This is the same as writing s.[i].
Source val of_bytes : bytes -> stringReturn a new string that contains the same bytes as the given byte sequence.
Source val to_bytes : string -> bytesReturn a new byte sequence that contains the same bytes as the given string.
Note. The Stdlib.(^)
Source val concat : string -> string list -> concat sep ss concatenates the list of strings ss, inserting the separator string sep between each.
Source val cat : string -> string -> stringcat s1 s2 concatenates s1 and s2 (s1 ^ s2).
equal s0 s1 is true if and only if s0 and s1 are character-wise equal.
Source val starts_with : prefix :string -> string -> boolstarts_with ~prefix s is true if and only if s starts with prefix.
Source val ends_with : suffix :string -> string -> boolends_with ~suffix s is true if and only if s ends with suffix.
Source val contains_from : string -> int -> char -> boolcontains_from s start c is true if and only if c appears in s after position start.
Source val rcontains_from : string -> int -> char -> boolrcontains_from s stop c is true if and only if c appears in s before position stop+1.
Source val contains : string -> char -> boolSource val sub : string -> int -> int -> stringsub s pos len is a string of length len, containing the substring of s that starts at position pos and has length len.
Source val map : (char -> char) -> string -> stringmap f s is the string resulting from applying f to all the characters of s in increasing order.
Source val mapi : (int -> char -> char) -> string -> stringmapi f s is like mapf.
Source val fold_left : ('acc -> char -> 'acc ) -> 'acc -> string -> 'acc fold_left f x s computes f (... (f (f x s.[0]) s.[1]) ...) s.[n-1], where n is the length of the string s.
Source val fold_right : (char -> 'acc -> 'acc ) -> string -> 'acc -> 'acc fold_right f s x computes f s.[0] (f s.[1] ( ... (f s.[n-1] x) ...)), where n is the length of the string s.
Source val trim : string -> stringtrim s is s without leading and trailing whitespace. Whitespace characters are: ' ', '\x0C' (form feed), '\n', '\r', and '\t'.
Source val escaped : string -> stringescaped s is s with special characters represented by escape sequences, following the lexical conventions of OCaml.
All characters outside the US-ASCII printable range [0x20;0x7E] are escaped, as well as backslash (0x2F) and double-quote (0x22).
The function Scanf.unescapedescaped, i.e. Scanf.unescaped (escaped s) = s for any string s (unless escaped s fails).
Source val uppercase_ascii : string -> stringuppercase_ascii s is s with all lowercase letters translated to uppercase, using the US-ASCII character set.
Source val lowercase_ascii : string -> stringlowercase_ascii s is s with all uppercase letters translated to lowercase, using the US-ASCII character set.
Source val capitalize_ascii : string -> stringcapitalize_ascii s is s with the first character set to uppercase, using the US-ASCII character set.
Source val uncapitalize_ascii : string -> stringuncapitalize_ascii s is s with the first character set to lowercase, using the US-ASCII character set.
Source val iteri : (int -> char -> unit) -> string -> unititeri is like iter
Source val index_from : string -> int -> char -> intindex_from s i c is the index of the first occurrence of c in s after position i.
Source val index_from_opt : string -> int -> char -> int option index_from_opt s i c is the index of the first occurrence of c in s after position i (if any).
Source val rindex_from : string -> int -> char -> intrindex_from s i c is the index of the last occurrence of c in s before position i+1.
Source val rindex_from_opt : string -> int -> char -> int option rindex_from_opt s i c is the index of the last occurrence of c in s before position i+1 (if any).
Source val index : string -> char -> intSource val index_opt : string -> char -> int option Source val rindex : string -> char -> intSource val rindex_opt : string -> char -> int option to_seqi s is like to_seq
get_utf_8_uchar b i decodes an UTF-8 character at index i in b.
Source val is_valid_utf_8 : t -> is_valid_utf_8 b is true if and only if b contains valid UTF-8 data.
get_utf_16be_uchar b i decodes an UTF-16BE character at index i in b.
Source val is_valid_utf_16be : t -> is_valid_utf_16be b is true if and only if b contains valid UTF-16BE data.
get_utf_16le_uchar b i decodes an UTF-16LE character at index i in b.
Source val is_valid_utf_16le : t -> is_valid_utf_16le b is true if and only if b contains valid UTF-16LE data.
The functions in this section binary decode integers from strings.
All following functions raise Invalid_argument if the characters needed at index i to decode the integer are not available.
Little-endian (resp. big-endian) encoding means that least (resp. most) significant bytes are stored first. Big-endian is also known as network byte order. Native-endian encoding is either little-endian or big-endian depending on Sys.big_endian
32-bit and 64-bit integers are represented by the int32 and int64 types, which can be interpreted either as signed or unsigned numbers.
8-bit and 16-bit integers are represented by the int type, which has more bits than the binary encoding. These extra bits are sign-extended (or zero-extended) for functions which decode 8-bit or 16-bit integers and represented them with int values.
Source val get_uint8 : string -> int -> intget_uint8 b i is b's unsigned 8-bit integer starting at character index i.
Source val get_int8 : string -> int -> intget_int8 b i is b's signed 8-bit integer starting at character index i.
Source val get_uint16_ne : string -> int -> intget_uint16_ne b i is b's native-endian unsigned 16-bit integer starting at character index i.
Source val get_uint16_be : string -> int -> intget_uint16_be b i is b's big-endian unsigned 16-bit integer starting at character index i.
Source val get_uint16_le : string -> int -> intget_uint16_le b i is b's little-endian unsigned 16-bit integer starting at character index i.
Source val get_int16_ne : string -> int -> intget_int16_ne b i is b's native-endian signed 16-bit integer starting at character index i.
Source val get_int16_be : string -> int -> intget_int16_be b i is b's big-endian signed 16-bit integer starting at character index i.
Source val get_int16_le : string -> int -> intget_int16_le b i is b's little-endian signed 16-bit integer starting at character index i.
Source val get_int32_ne : string -> int -> int32get_int32_ne b i is b's native-endian 32-bit integer starting at character index i.
Source val seeded_hash : int -> t -> Source val get_int32_be : string -> int -> int32get_int32_be b i is b's big-endian 32-bit integer starting at character index i.
Source val get_int32_le : string -> int -> int32get_int32_le b i is b's little-endian 32-bit integer starting at character index i.
Source val get_int64_ne : string -> int -> int64get_int64_ne b i is b's native-endian 64-bit integer starting at character index i.
Source val get_int64_be : string -> int -> int64get_int64_be b i is b's big-endian 64-bit integer starting at character index i.
Source val get_int64_le : string -> int -> int64get_int64_le b i is b's little-endian 64-bit integer starting at character index i.
length s returns the length (number of characters) of the given string s.
blit src src_pos dst dst_pos len copies len characters from string src starting at character indice src_pos, to the Bytes sequence dst starting at character indice dst_pos. Like String.blit-safe-string option.
Source val fold : ('a -> char -> 'a ) -> 'a -> t -> 'a fold f init s folds on chars by increasing index. Computes f(… (f (f init s.[0]) s.[1]) …) s.[n-1].
Source val foldi : ('a -> int -> char -> 'a ) -> 'a -> t -> 'a foldi f init s is just like foldf.
to_gen s returns the gen of characters contained in the string s.
to_iter s returns the iter of characters contained in the string s.
to_seq s returns the Seq.t of characters contained in the string s. Renamed from to std_seq since 3.0.
to_list s returns the list of characters contained in the string s.
pp_buf buf s prints s to the buffer buf. Renamed from pp since 2.0.
pp f s prints the string s within quotes to the formatter f. Renamed from print since 2.0.
Source val compare : string -> string -> intcompare s1 s2 compares the strings s1 and s2 and returns an integer that indicates their relative position in the sort order.
Source val is_empty : string -> boolis_empty s returns true iff s is empty (i.e. its length is 0).
Source val hash : string -> inthash s returns the hash value of s.
Source val rev : string -> stringrev s returns the reverse of s.
Source val pad : ?side :[ `Left | `Right ] -> ?c :char -> int -> string -> stringpad ~side ~c n s ensures that the string s is at least n bytes long, and pads it on the side with c if it's not the case.
Source val of_char : char -> stringof_gen gen converts a gen of characters to a string.
of_iter iter converts an iter of characters to a string.
of_seq seq converts a seq of characters to a string. Renamed from of_std_seq since 3.0.
Source val of_list : char list -> of_list lc converts a list of characters lc to a string.
Source val of_array : char array -> of_array ac converts an array of characters ac to a string.
Source val to_array : string -> char array to_array s returns the array of characters contained in the string s.
Source val find : ?start :int -> sub :string -> string -> intfind ~start ~sub s returns the starting index of the first occurrence of sub within s or -1.
Source val find_all : ?start :int -> sub :string -> string -> int gen find_all ~start ~sub s finds all occurrences of sub in s, even overlapping instances and returns them in a generator gen.
Source val find_all_l : ?start :int -> sub :string -> string -> int list find_all_l ~sub s finds all occurrences of sub in s and returns them in a list.
Source val mem : ?start :int -> sub :string -> string -> boolmem ~start ~sub s is true iff sub is a substring of s.
Source val rfind : sub :string -> string -> intrfind ~sub s finds sub in string s from the right, returns its first index or -1. Should only be used with very small sub.
Source val replace :
?which :[ `Left | `Right | `All ] -> sub :string -> by :string -> string ->
stringreplace ~which ~sub ~by s replaces some occurrences of sub by by in s.
Source val is_sub : sub :string -> int -> string -> int -> sub_len :int -> is_sub ~sub ~sub_pos s ~pos ~sub_len returns true iff the substring of sub starting at position sub_pos and of length sub_len is a substring of s starting at position pos.
Source val repeat : string -> int -> stringrepeat s n creates a string by repeating the string s n times.
Source val prefix : pre :string -> string -> boolprefix ~pre s returns true iff pre is a prefix of s.
Source val suffix : suf :string -> string -> boolsuffix ~suf s returns true iff suf is a suffix of s.
Source val chop_prefix : pre :string -> string -> string option chop_prefix ~pre s removes pre from s if pre really is a prefix of s, returns None otherwise.
Source val chop_suffix : suf :string -> string -> string option chop_suffix ~suf s removes suf from s if suf really is a suffix of s, returns None otherwise.
Source val take : int -> string -> stringtake n s keeps only the n first chars of s.
Source val take_while : (char -> bool) -> string -> stringtake_while f s keeps only the longest prefix t of s such that every character c in t satisfies f c.
Source val rtake_while : (char -> bool) -> string -> stringrtake_while f s keeps only the longest suffix t of s such that every character c in t satisfies f c.
Source val drop : int -> string -> stringdrop n s removes the n first chars of s.
Source val take_drop : int -> string -> string * stringtake_drop n s is take n s, drop n s.
Source val lines : string -> string list lines s returns a list of the lines of s (splits along '\n').
lines_gen s returns the gen of the lines of s (splits along '\n').
lines_iter s returns the iter of the lines of s (splits along '\n').
lines_seq s returns the Seq.t of the lines of s (splits along '\n').
Source val concat_gen : sep :string -> string gen -> concat_gen ~sep gen concatenates all strings of gen, separated with sep.
Source val concat_seq : sep :string -> string Seq.t -> concat_seq ~sep seq concatenates all strings of seq, separated with sep.
Source val concat_iter : sep :string -> string iter -> concat_iter ~sep iter concatenates all strings of iter, separated with sep.
Source val unlines : string list -> unlines ls concatenates all strings of ls, separated with '\n'.
unlines_gen gen concatenates all strings of gen, separated with '\n'.
unlines_iter iter concatenates all strings of iter, separated with '\n'.
unlines_seq seq concatenates all strings of seq, separated with '\n'.
Source val set : string -> int -> char -> stringset s i c creates a new string which is a copy of s, except for index i, which becomes c.
Source val iter : (char -> unit) -> string -> unititer f s applies function f on each character of s. Alias to String.iter
Source val filter_map : (char -> char option ) -> string -> stringfilter_map f s calls (f a0) (f a1) … (f an) where a0 … an are the characters of s. It returns the string of characters ci such as f ai = Some ci (when f returns None, the corresponding element of s is discarded).
Source val filter : (char -> bool) -> string -> stringfilter f s discards characters of s not satisfying f.
Source val uniq : (char -> char -> bool) -> string -> stringuniq eq s remove consecutive duplicate characters in s.
Source val flat_map : ?sep :string -> (char -> string) -> string -> stringflat_map ~sep f s maps each chars of s to a string, then concatenates them all.
Source val for_all : (char -> bool) -> string -> boolfor_all f s is true iff all characters of s satisfy the predicate f.
Source val exists : (char -> bool) -> string -> boolexists f s is true iff some character of s satisfy the predicate f.
Source val drop_while : (char -> bool) -> t -> t drop_while f s discards any characters of s starting from the left, up to the first character c not satisfying f c.
Source val rdrop_while : (char -> bool) -> t -> t rdrop_while f s discards any characters of s starting from the right, up to the first character c not satisfying f c.
ltrim s trims space on the left (see String.trim
rtrim s trims space on the right (see String.trim
Source val map2 : (char -> char -> char) -> string -> string -> stringmap2 f s1 s2 maps pairs of chars.
Source val iter2 : (char -> char -> unit) -> string -> string -> unititer2 f s1 s2 iterates on pairs of chars.
Source val iteri2 : (int -> char -> char -> unit) -> string -> string -> unititeri2 f s1 s2 iterates on pairs of chars with their index.
Source val fold2 : ('a -> char -> char -> 'a ) -> 'a -> string -> string -> 'a fold2 f init s1 s2 folds on pairs of chars.
Source val for_all2 : (char -> char -> bool) -> string -> string -> boolfor_all2 f s1 s2 returns true iff all pairs of chars satisfy the predicate f.
Source val exists2 : (char -> char -> bool) -> string -> string -> boolexists2 f s1 s2 returns true iff a pair of chars satisfy the predicate f.
Those functions are deprecated in String
Source val equal_caseless : string -> string -> boolequal_caseless s1 s2 compares s1 and s2 without respect to ascii lowercase.
Source val to_hex : string -> stringConvert a string with arbitrary content into a hexadecimal string.
Source val of_hex : string -> string option Convert a string in hex into a string with arbitrary content.
Source val of_hex_exn : string -> stringSame as of_hex
A relatively efficient algorithm for finding sub-strings.
Source val split_on_char : char -> string -> string list split_on_char by s splits the string s along the given char by.
Source val split : by :string -> string -> string list split ~by s splits the string s along the given string by. Alias to Split.list_cpy
Source val compare_versions : string -> string -> intcompare_versions s1 s2 compares version strings s1 and s2, considering that numbers are above text.
Source val compare_natural : string -> string -> intcompare_natural s1 s2 is the Natural Sort Order, comparing chunks of digits as natural numbers. https://en.wikipedia.org/wiki/Natural_sort_order
Source val edit_distance : ?cutoff :int -> string -> string -> intedit_distance ~cutoff s1 s2 is the edition distance between the two strings s1 and s2. This satisfies the classical distance axioms: it is always positive, symmetric, and satisfies the formula distance s1 s2 + distance s2 s3 >= distance s1 s3.
include module type of Infix