Basic String Utils
Consider using Containers_string.KMP for pattern search, or Regex libraries.
type 'a gen = unit -> 'a optiontype 'a sequence = ('a -> unit) -> unittype 'a klist = unit -> [ `Nil | `Cons of 'a * 'a klist ]Common Signature
module type S = sig ... endStrings
val equal : string -> string -> boolval compare : string -> string -> intval init : int -> (int -> char) -> stringval rev : string -> stringrev s returns the reverse of s
val pad : ?side:[ `Left | `Right ] -> ?c:char -> int -> string -> stringpad n str ensures that str is at least n bytes long, and pads it on the side with c if it's not the case.
val of_gen : char gen -> stringval of_klist : char klist -> stringval of_list : char list -> stringval of_array : char array -> stringval to_array : string -> char arrayval find : ?start:int -> sub:string -> string -> intFind sub in string, returns its first index or -1. Should only be used with very small sub
val find_all : ?start:int -> sub:string -> string -> int genfind_all ~sub s finds all occurrences of sub in s, even overlapping instances.
val find_all_l : ?start:int -> sub:string -> string -> int listfind_all ~sub s finds all occurrences of sub in s and returns them in a list
val mem : ?start:int -> sub:string -> string -> boolmem ~sub s is true iff sub is a substring of s
val rfind : sub:string -> string -> intFind sub in string from the right, returns its first index or -1. Should only be used with very small sub
val replace :
?which:[ `Left | `Right | `All ] ->
sub:string ->
by:string ->
string ->
stringreplace ~sub ~by s replaces some occurrences of sub by by in s
val is_sub : sub:string -> int -> string -> int -> len:int -> boolis_sub ~sub i s j ~len returns true iff the substring of sub starting at position i and of length len is a substring of s starting at position j
val repeat : string -> int -> stringThe same string, repeated n times
val prefix : pre:string -> string -> boolprefix ~pre s returns true iff pre is a prefix of s
val suffix : suf:string -> string -> boolsuffix ~suf s returns true iff suf is a suffix of s
val chop_prefix : pre:string -> string -> string optionchop_pref ~pre s removes pre from s if pre really is a prefix of s, returns None otherwise
val chop_suffix : suf:string -> string -> string optionchop_suffix ~suf s removes suf from s if suf really is a suffix of s, returns None otherwise
val take : int -> string -> stringtake n s keeps only the n first chars of s
val drop : int -> string -> stringdrop n s removes the n first chars of s
val take_drop : int -> string -> string * stringtake_drop n s = take n s, drop n s
val lines : string -> string listlines s returns a list of the lines of s (splits along '\n')
val lines_gen : string -> string genlines_gen s returns a generator of the lines of s (splits along '\n')
val concat_gen : sep:string -> string gen -> stringconcat_gen ~sep g concatenates all strings of g, separated with sep.
val unlines : string list -> stringunlines l concatenates all strings of l, separated with '\n'
val unlines_gen : string gen -> stringunlines_gen g concatenates all strings of g, separated with '\n'
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.
val iter : (char -> unit) -> string -> unitval iteri : (int -> char -> unit) -> string -> unitIter on chars with their index
val map : (char -> char) -> string -> stringval mapi : (int -> char -> char) -> string -> stringMap chars with their index
val filter_map : (char -> char option) -> string -> stringval filter : (char -> bool) -> string -> stringval flat_map : ?sep:string -> (char -> string) -> string -> stringMap each chars to a string, then concatenates them all
val for_all : (char -> bool) -> string -> boolval exists : (char -> bool) -> string -> boolinclude S with type t := string
val length : string -> intval blit : string -> int -> Bytes.t -> int -> int -> unitSimilar to String.blit. Compatible with the -safe-string option.
val fold : ('a -> char -> 'a) -> 'a -> string -> 'aFold on chars by increasing index.
Conversions
val to_gen : string -> char genval to_klist : string -> char klistval to_list : string -> char listPrint the string within quotes
Operations on 2 strings
val map2 : (char -> char -> char) -> string -> string -> stringval iter2 : (char -> char -> unit) -> string -> string -> unitIterate on pairs of chars
val iteri2 : (int -> char -> char -> unit) -> string -> string -> unitIterate on pairs of chars with their index
val fold2 : ('a -> char -> char -> 'a) -> 'a -> string -> string -> 'aval for_all2 : (char -> char -> bool) -> string -> string -> boolAll pairs of chars respect the predicate?
val exists2 : (char -> char -> bool) -> string -> string -> boolAscii functions
Those functions are deprecated in String since 4.03, so we provide a stable alias for them even in older versions
val capitalize_ascii : string -> stringval uncapitalize_ascii : string -> stringval uppercase_ascii : string -> stringval lowercase_ascii : string -> stringSplitting
module Split : sig ... endUtils
val compare_versions : string -> string -> intcompare_versions a b compares version strings a and b, considering that numbers are above text.
Slices
A contiguous part of a string