To focus the search input from anywhere on the page, press the 'S' key.
in-package search v0.1.0
-
bigarray
-
dynlink
-
ocamlbytecomp
-
ocamlcommon
-
ocamlmiddleend
-
ocamloptcomp
-
odoc_info
-
stdlib
-
str
-
unix
Library
Module
Module type
Parameter
Class
Class type
include module type of String
Strings
make n c
is a string of length n
with each index holding the character c
.
- raises Invalid_argument
if
n < 0
orn >
Sys.max_string_length
.
init n f
is a string of length n
with index i
holding the character f i
(called in increasing index order).
- raises Invalid_argument
if
n < 0
orn >
Sys.max_string_length
.
- since 4.02.0
Return a new string that contains the same bytes as the given byte sequence.
- since 4.13.0
Return a new byte sequence that contains the same bytes as the given string.
- since 4.13.0
get s i
is the character at index i
in s
. This is the same as writing s.[i]
.
- raises Invalid_argument
if
i
not an index ofs
.
Concatenating
Note. The Stdlib
.(^) binary operator concatenates two strings.
concat sep ss
concatenates the list of strings ss
, inserting the separator string sep
between each.
- raises Invalid_argument
if the result is longer than
Sys.max_string_length
bytes.
cat s1 s2
concatenates s1 and s2 (s1 ^ s2
).
- raises Invalid_argument
if the result is longer than
Sys.max_string_length
bytes.
- since 4.13.0
Predicates and comparisons
equal s0 s1
is true
if and only if s0
and s1
are character-wise equal.
- since 4.03.0 (4.05.0 in StringLabels)
compare s0 s1
sorts s0
and s1
in lexicographical order. compare
behaves like Stdlib.compare
on strings but may be more efficient.
starts_with
~prefix s
is true
if and only if s
starts with prefix
.
- since 4.13.0
ends_with
~suffix s
is true
if and only if s
ends with suffix
.
- since 4.13.0
contains_from s start c
is true
if and only if c
appears in s
after position start
.
- raises Invalid_argument
if
start
is not a valid position ins
.
rcontains_from s stop c
is true
if and only if c
appears in s
before position stop+1
.
- raises Invalid_argument
if
stop < 0
orstop+1
is not a valid position ins
.
contains s c
is String.contains_from
s 0 c
.
Extracting substrings
sub s pos len
is a string of length len
, containing the substring of s
that starts at position pos
and has length len
.
- raises Invalid_argument
if
pos
andlen
do not designate a valid substring ofs
.
split_on_char sep s
is the list of all (possibly empty) substrings of s
that are delimited by the character sep
.
The function's result 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 (concat (make 1 sep) (split_on_char sep s) = s
). - No string in the result contains the
sep
character.
- since 4.04.0 (4.05.0 in StringLabels)
Transforming
map f s
is the string resulting from applying f
to all the characters of s
in increasing order.
- since 4.00.0
mapi f s
is like map
but the index of the character is also passed to f
.
- since 4.02.0
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
.
- since 4.13.0
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
.
- since 4.13.0
exists p s
checks if at least one character of s
satisfies the predicate p
.
- since 4.13.0
trim s
is s
without leading and trailing whitespace. Whitespace characters are: ' '
, '\x0C'
(form feed), '\n'
, '\r'
, and '\t'
.
- since 4.00.0
escaped 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.unescaped
is a left inverse of escaped
, i.e. Scanf.unescaped (escaped s) = s
for any string s
(unless escaped s
fails).
- raises Invalid_argument
if the result is longer than
Sys.max_string_length
bytes.
uppercase_ascii s
is s
with all lowercase letters translated to uppercase, using the US-ASCII character set.
- since 4.03.0 (4.05.0 in StringLabels)
lowercase_ascii s
is s
with all uppercase letters translated to lowercase, using the US-ASCII character set.
- since 4.03.0 (4.05.0 in StringLabels)
capitalize_ascii s
is s
with the first character set to uppercase, using the US-ASCII character set.
- since 4.03.0 (4.05.0 in StringLabels)
uncapitalize_ascii s
is s
with the first character set to lowercase, using the US-ASCII character set.
- since 4.03.0 (4.05.0 in StringLabels)
Traversing
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.[length s - 1]; ()
.
iteri
is like iter
, but the function is also given the corresponding character index.
- since 4.00.0
Searching
index_from s i c
is the index of the first occurrence of c
in s
after position i
.
- raises Not_found
if
c
does not occur ins
after positioni
.
- raises Invalid_argument
if
i
is not a valid position ins
.
index_from_opt s i c
is the index of the first occurrence of c
in s
after position i
(if any).
- raises Invalid_argument
if
i
is not a valid position ins
.
- since 4.05
rindex_from s i c
is the index of the last occurrence of c
in s
before position i+1
.
- raises Not_found
if
c
does not occur ins
before positioni+1
.
- raises Invalid_argument
if
i+1
is not a valid position ins
.
rindex_from_opt s i c
is the index of the last occurrence of c
in s
before position i+1
(if any).
- raises Invalid_argument
if
i+1
is not a valid position ins
.
- since 4.05
index s c
is String.index_from
s 0 c
.
index_opt s c
is String.index_from_opt
s 0 c
.
- since 4.05
rindex s c
is String.rindex_from
s (length s - 1) c
.
rindex_opt s c
is String.rindex_from_opt
s (length s - 1) c
.
- since 4.05
Strings and Sequences
to_seq s
is a sequence made of the string's characters in increasing order. In "unsafe-string"
mode, modifications of the string during iteration will be reflected in the sequence.
- since 4.07
to_seqi s
is like to_seq
but also tuples the corresponding index.
- since 4.07
UTF decoding and validations
- since 4.14
UTF-8
val get_utf_8_uchar : t -> int -> Uchar.utf_decode
get_utf_8_uchar b i
decodes an UTF-8 character at index i
in b
.
val is_valid_utf_8 : t -> bool
is_valid_utf_8 b
is true
if and only if b
contains valid UTF-8 data.
UTF-16BE
val get_utf_16be_uchar : t -> int -> Uchar.utf_decode
get_utf_16be_uchar b i
decodes an UTF-16BE character at index i
in b
.
val is_valid_utf_16be : t -> bool
is_valid_utf_16be b
is true
if and only if b
contains valid UTF-16BE data.
UTF-16LE
val get_utf_16le_uchar : t -> int -> Uchar.utf_decode
get_utf_16le_uchar b i
decodes an UTF-16LE character at index i
in b
.
val is_valid_utf_16le : t -> bool
is_valid_utf_16le b
is true
if and only if b
contains valid UTF-16LE data.
Deprecated functions
create n
returns a fresh byte sequence of length n
. The sequence is uninitialized and contains arbitrary bytes.
- raises Invalid_argument
if
n < 0
orn >
Sys.max_string_length
.
- deprecated
This is a deprecated alias of
Bytes.create
/BytesLabels.create
.
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 set s n c
.
- raises Invalid_argument
if
n
is not a valid index ins
.
- deprecated
This is a deprecated alias of
Bytes.set
/BytesLabels.set
.
blit src src_pos dst dst_pos len
copies len
bytes from the string src
, starting at index src_pos
, to byte sequence dst
, starting at character number dst_pos
.
- raises Invalid_argument
if
src_pos
andlen
do not designate a valid range ofsrc
, or ifdst_pos
andlen
do not designate a valid range ofdst
.
Return a copy of the given string.
- deprecated
Because strings are immutable, it doesn't make much sense to make identical copies of them.
fill s pos len c
modifies byte sequence s
in place, replacing len
bytes by c
, starting at pos
.
- raises Invalid_argument
if
pos
andlen
do not designate a valid substring ofs
.
- deprecated
This is a deprecated alias of
Bytes.fill
/BytesLabels.fill
.<