Module `Stdune.String`

type t = string

include module type of struct include StringLabels end with type t := t

val length : string -> int

Return the length (number of characters) of the given string.

val get : string -> int -> char

String.get s n returns the character at index n in string s. You can also write s.[n] instead of String.get s n.

raises Invalid_argument
if n not a valid index in s.

val set : bytes -> int -> char -> unit

String.set s n c modifies byte sequence s in place, replacing the byte at index n with c. You can also write s.[n] <- c instead of String.set s n c.

raises Invalid_argument
if n is not a valid index in s.

deprecated
This is a deprecated alias of BytesLabels.set.

val create : int -> bytes

String.create n returns a fresh byte sequence of length n. The sequence is uninitialized and contains arbitrary bytes.

raises Invalid_argument
if n < 0 or n > Sys.max_string_length.

deprecated
This is a deprecated alias of BytesLabels.create.

val make : int -> char -> string

String.make n c returns a fresh string of length n, filled with the character c.

raises Invalid_argument
if n < 0 or n > Sys.max_string_length.

val init : int -> f:(int -> char) -> string

init n f returns a string of length n, with character i initialized to the result of f i.

raises Invalid_argument
if n < 0 or n > Sys.max_string_length.

since 4.02.0

val copy : string -> string

Return a copy of the given string.

deprecated

val sub : string -> pos:int -> len:int -> string

String.sub s start len returns a fresh string of length len, containing the substring of s that starts at position start and has length len.

raises Invalid_argument
if start and len do not designate a valid substring of s.

val fill : bytes -> pos:int -> len:int -> char -> unit

String.fill s start len c modifies byte sequence s in place, replacing len bytes by c, starting at start.

raises Invalid_argument
if start and len do not designate a valid substring of s.

deprecated
This is a deprecated alias of BytesLabels.fill.

val blit : 
  src:string ->
  src_pos:int ->
  dst:bytes ->
  dst_pos:int ->
  len:int ->
  unit

String.blit src srcoff dst dstoff len copies len bytes from the string src, starting at index srcoff, to byte sequence dst, starting at character number dstoff.

raises Invalid_argument
if srcoff and len do not designate a valid range of src, or if dstoff and len do not designate a valid range of dst.

val concat : sep:string -> string list -> string

String.concat sep sl concatenates the list of strings sl, inserting the separator string sep between each.

val iter : f:(char -> unit) -> string -> unit

String.iter f s applies function f in turn to all the characters of s. It is equivalent to f s.[0]; f s.[1]; ...; f s.[String.length s - 1]; ().

val iteri : f:(int -> char -> unit) -> string -> unit

Same as String.iter, but the function is applied to the index of the element as first argument (counting from 0), and the character itself as second argument.

since 4.00.0

val map : f:(char -> char) -> string -> string

String.map f s applies function f in turn to all the characters of s and stores the results in a new string that is returned.

since 4.00.0

val mapi : f:(int -> char -> char) -> string -> string

String.mapi f s calls f with each character of s and its index (in increasing index order) and stores the results in a new string that is returned.

since 4.02.0

val trim : string -> string

Return a copy of the argument, without leading and trailing whitespace. The characters regarded as whitespace are: ' ', '\012', '\n', '\r', and '\t'. If there is no leading nor trailing whitespace character in the argument, return the original string itself, not a copy.

since 4.00.0

val escaped : string -> string

Return a copy of the argument, with special characters represented by escape sequences, following the lexical conventions of OCaml. If there is no special character in the argument, return the original string itself, not a copy. Its inverse function is Scanf.unescaped.

val index_opt : string -> char -> int option

String.index_opt s c returns the index of the first occurrence of character c in string s, or None if c does not occur in s.

since 4.05

val rindex_opt : string -> char -> int option

String.rindex_opt s c returns the index of the last occurrence of character c in string s, or None if c does not occur in s.

since 4.05

val index_from_opt : string -> int -> char -> int option

String.index_from_opt s i c returns the index of the first occurrence of character c in string s after position i or None if c does not occur in s after position i.

String.index_opt s c is equivalent to String.index_from_opt s 0 c.

raises Invalid_argument
if i is not a valid position in s.

since 4.05

val rindex_from_opt : string -> int -> char -> int option

String.rindex_from_opt s i c returns the index of the last occurrence of character c in string s before position i+1 or None if c does not occur in s before position i+1.

String.rindex_opt s c is equivalent to String.rindex_from_opt s (String.length s - 1) c.

raises Invalid_argument
if i+1 is not a valid position in s.

since 4.05

val contains : string -> char -> bool

String.contains s c tests if character c appears in the string s.

val contains_from : string -> int -> char -> bool

String.contains_from s start c tests if character c appears in s after position start. String.contains s c is equivalent to String.contains_from s 0 c.

raises Invalid_argument
if start is not a valid position in s.

val rcontains_from : string -> int -> char -> bool

String.rcontains_from s stop c tests if character c appears in s before position stop+1.

raises Invalid_argument
if stop < 0 or stop+1 is not a valid position in s.

val uppercase_ascii : string -> string

Return a copy of the argument, with all lowercase letters translated to uppercase, using the US-ASCII character set.

since 4.05.0

val lowercase_ascii : string -> string

Return a copy of the argument, with all uppercase letters translated to lowercase, using the US-ASCII character set.

since 4.05.0

val capitalize_ascii : string -> string

Return a copy of the argument, with the first character set to uppercase, using the US-ASCII character set.

since 4.05.0

val uncapitalize_ascii : string -> string

Return a copy of the argument, with the first character set to lowercase, using the US-ASCII character set.

since 4.05.0

val split_on_char : sep:char -> string -> string list

String.split_on_char sep s returns the list of all (possibly empty) substrings of s that are delimited by the sep character.

The function's output is specified by the following invariants:

The list is not empty.
Concatenating its elements using sep as a separator returns a string equal to the input (String.concat (String.make 1 sep) (String.split_on_char sep s) = s).
No string in the result contains the sep character.

since 4.05.0

Iterators

val to_seq : t -> char Seq.t

Iterate on the string, in increasing index order. Modifications of the string during iteration will be reflected in the iterator.

since 4.07

val to_seqi : t -> (int * char) Seq.t

Iterate on the string, in increasing order, yielding indices along chars

since 4.07

val of_seq : char Seq.t -> t

Create a string from the generator

since 4.07

val equal : t -> t -> bool

val compare : t -> t -> Ordering.t

val hash : t -> int

val to_dyn : t -> Dyn.t

val break : t -> pos:int -> t * t

val is_empty : t -> bool

val of_list : char list -> t

val is_prefix : t -> prefix:t -> bool

val is_suffix : t -> suffix:t -> bool

val take : t -> int -> t

val drop : t -> int -> t

val split_n : t -> int -> t * t

val drop_prefix : t -> prefix:t -> t option

val drop_suffix : t -> suffix:t -> t option

val capitalize : t -> t

These only change ASCII characters

val uncapitalize : t -> t

val uppercase : t -> t

val lowercase : t -> t

val index : t -> char -> int option

val index_from : t -> int -> char -> int option

val rindex : t -> char -> int option

val rindex_from : t -> int -> char -> int option

val extract_words : t -> is_word_char:(char -> bool) -> t list

val extract_comma_space_separated_words : t -> t list

val extract_blank_separated_words : t -> t list

val lsplit2 : t -> on:char -> (t * t) option

val lsplit2_exn : t -> on:char -> t * t

val rsplit2 : t -> on:char -> (t * t) option

val split : t -> on:char -> t list

val split_lines : t -> t list

val escape_only : char -> t -> t

Escace ONLY one character. escape also escapes '\n',... and transforms all chars above '~' into '\xxx' which is not suitable for UTF-8 strings.

val longest : string list -> int

Return the length of the longest string in the list

val longest_map : 'a list -> f:('a -> string) -> int

val longest_prefix : t list -> t

val exists : t -> f:(char -> bool) -> bool

val for_all : t -> f:(char -> bool) -> bool

val maybe_quoted : t -> t

maybe_quoted s is s if s doesn't need escaping according to OCaml lexing conventions and sprintf "%S" s otherwise.

(* CR-someday aalekseyev: this function is not great: barely anything "needs escaping according to OCaml lexing conventions", so the condition for whether to add the quote characters ends up being quite arbitrary. *)

val enumerate_and : string list -> string

Produces: "x, y and z"

val enumerate_or : string list -> string

Produces: "x, y or z"

val enumerate_one_of : t list -> t

Produces: "One of x, y or z"

val findi : ?from:int -> string -> f:(char -> bool) -> int option

Find index of first character satisfying f

val rfindi : ?from:int -> string -> f:(char -> bool) -> int option

Find index of last character satisfying f

module Set : sig ... end

module Map : sig ... end

module Table : Hashtbl.S with type key = t

val need_quoting : string -> bool

Whether the string needs quoting if it is part of a shell command

val quote_for_shell : string -> string

quote_for_shell s quotes s using Filename.quote if need_quoting s is true

Install

Dune Dependency

Authors

Maintainers

Sources

doc/lsp.stdune/Stdune/String/index.html

Module `Stdune.String`

Iterators

package lsp

Install

Dune Dependency

Authors

Maintainers

Sources

doc/lsp.stdune/Stdune/String/index.html

Module Stdune.String

Iterators

Module `Stdune.String`