1Stdlib.String(3) OCaml library Stdlib.String(3)
2
6 Stdlib.String - no description
7
9 Module Stdlib.String
10
12 Module String
13 : (module Stdlib__string)
14 val length : string -> int
23 Return the length (number of characters) of the given string.
25 val get : string -> int -> char
29 String.get s n returns the character at index n in string s . You can
32 also write s.[n] instead of String.get s n .
33 Raises Invalid_argument if n not a valid index in s .
36 val set : bytes -> int -> char -> unit
40 Deprecated. This is a deprecated alias of Bytes.set .
42 String.set s n c modifies byte sequence s in place, replacing the byte
47 at index n with c . You can also write s.[n] <- c instead of
48 String.set s n c .
49 Raises Invalid_argument if n is not a valid index in s .
52 val create : int -> bytes
56 Deprecated. This is a deprecated alias of Bytes.create .
58 String.create n returns a fresh byte sequence of length n . The
63 sequence is uninitialized and contains arbitrary bytes.
64 Raises Invalid_argument if n < 0 or n > Sys.max_string_length .
67 val make : int -> char -> string
71 String.make n c returns a fresh string of length n , filled with the
74 character c .
75 Raises Invalid_argument if n < 0 or n > Sys.max_string_length .
78 val init : int -> (int -> char) -> string
82 String.init n f returns a string of length n , with character i ini‐
85 tialized to the result of f i (called in increasing index order).
86 Since 4.02.0
89 Raises Invalid_argument if n < 0 or n > Sys.max_string_length .
92 val copy : string -> string
96 Deprecated. Because strings are immutable, it doesn't make much sense
98 to make identical copies of them.
99 Return a copy of the given string.
102 val sub : string -> int -> int -> string
106 String.sub s start len returns a fresh string of length len , contain‐
109 ing the substring of s that starts at position start and has length len
110 .
111 Raises Invalid_argument if start and len do not designate a valid sub‐
114 string of s .
115 val fill : bytes -> int -> int -> char -> unit
119 Deprecated. This is a deprecated alias of Bytes.fill .
121 String.fill s start len c modifies byte sequence s in place, replacing
126 len bytes with c , starting at start .
127 Raises Invalid_argument if start and len do not designate a valid range
130 of s .
131 val blit : string -> int -> bytes -> int -> int -> unit
135 Same as Bytes.blit_string .
137 val concat : string -> string list -> string
141 String.concat sep sl concatenates the list of strings sl , inserting
144 the separator string sep between each.
145 Raises Invalid_argument if the result is longer than
148 Sys.max_string_length bytes.
149 val iter : (char -> unit) -> string -> unit
153 String.iter f s applies function f in turn to all the characters of s .
156 It is equivalent to f s.[0]; f s.[1]; ...; f s.[String.length s - 1];
157 () .
158 val iteri : (int -> char -> unit) -> string -> unit
162 Same as String.iter , but the function is applied to the index of the
164 element as first argument (counting from 0), and the character itself
165 as second argument.
166 Since 4.00.0
169 val map : (char -> char) -> string -> string
173 String.map f s applies function f in turn to all the characters of s
176 (in increasing index order) and stores the results in a new string that
177 is returned.
178 Since 4.00.0
181 val mapi : (int -> char -> char) -> string -> string
185 String.mapi f s calls f with each character of s and its index (in
188 increasing index order) and stores the results in a new string that is
189 returned.
190 Since 4.02.0
193 val trim : string -> string
197 Return a copy of the argument, without leading and trailing whitespace.
199 The characters regarded as whitespace are: ' ' , '\012' , '\n' , '\r' ,
200 and '\t' . If there is neither leading nor trailing whitespace charac‐
201 ter in the argument, return the original string itself, not a copy.
202 Since 4.00.0
205 val escaped : string -> string
209 Return a copy of the argument, with special characters represented by
211 escape sequences, following the lexical conventions of OCaml. All
212 characters outside the ASCII printable range (32..126) are escaped, as
213 well as backslash and double-quote.
214 If there is no special character in the argument that needs escaping,
216 return the original string itself, not a copy.
217 Raises Invalid_argument if the result is longer than
220 Sys.max_string_length bytes.
221 The function Scanf.unescaped is a left inverse of escaped , i.e.
223 Scanf.unescaped (escaped s) = s for any string s (unless escape s
224 fails).
225 val index : string -> char -> int
229 String.index s c returns the index of the first occurrence of character
232 c in string s .
233 Raises Not_found if c does not occur in s .
236 val index_opt : string -> char -> int option
240 String.index_opt s c returns the index of the first occurrence of char‐
243 acter c in string s , or None if c does not occur in s .
244 Since 4.05
247 val rindex : string -> char -> int
251 String.rindex s c returns the index of the last occurrence of character
254 c in string s .
255 Raises Not_found if c does not occur in s .
258 val rindex_opt : string -> char -> int option
262 String.rindex_opt s c returns the index of the last occurrence of char‐
265 acter c in string s , or None if c does not occur in s .
266 Since 4.05
269 val index_from : string -> int -> char -> int
273 String.index_from s i c returns the index of the first occurrence of
276 character c in string s after position i . String.index s c is equiva‐
277 lent to String.index_from s 0 c .
278 Raises Invalid_argument if i is not a valid position in s .
281 Raises Not_found if c does not occur in s after position i .
284 val index_from_opt : string -> int -> char -> int option
288 String.index_from_opt s i c returns the index of the first occurrence
291 of character c in string s after position i or None if c does not occur
292 in s after position i .
293 String.index_opt s c is equivalent to String.index_from_opt s 0 c .
296 Since 4.05
299 Raises Invalid_argument if i is not a valid position in s .
302 val rindex_from : string -> int -> char -> int
306 String.rindex_from s i c returns the index of the last occurrence of
309 character c in string s before position i+1 . String.rindex s c is
310 equivalent to String.rindex_from s (String.length s - 1) c .
311 Raises Invalid_argument if i+1 is not a valid position in s .
314 Raises Not_found if c does not occur in s before position i+1 .
317 val rindex_from_opt : string -> int -> char -> int option
321 String.rindex_from_opt s i c returns the index of the last occurrence
324 of character c in string s before position i+1 or None if c does not
325 occur in s before position i+1 .
326 String.rindex_opt s c is equivalent to String.rindex_from_opt s
329 (String.length s - 1) c .
330 Since 4.05
333 Raises Invalid_argument if i+1 is not a valid position in s .
336 val contains : string -> char -> bool
340 String.contains s c tests if character c appears in the string s .
343 val contains_from : string -> int -> char -> bool
347 String.contains_from s start c tests if character c appears in s after
350 position start . String.contains s c is equivalent to String.con‐
351 tains_from s 0 c .
352 Raises Invalid_argument if start is not a valid position in s .
355 val rcontains_from : string -> int -> char -> bool
359 String.rcontains_from s stop c tests if character c appears in s before
362 position stop+1 .
363 Raises Invalid_argument if stop < 0 or stop+1 is not a valid position
366 in s .
367 val uppercase : string -> string
371 Deprecated. Functions operating on Latin-1 character set are depre‐
373 cated.
374 Return a copy of the argument, with all lowercase letters translated to
377 uppercase, including accented letters of the ISO Latin-1 (8859-1) char‐
378 acter set.
379 val lowercase : string -> string
383 Deprecated. Functions operating on Latin-1 character set are depre‐
385 cated.
386 Return a copy of the argument, with all uppercase letters translated to
389 lowercase, including accented letters of the ISO Latin-1 (8859-1) char‐
390 acter set.
391 val capitalize : string -> string
395 Deprecated. Functions operating on Latin-1 character set are depre‐
397 cated.
398 Return a copy of the argument, with the first character set to upper‐
401 case, using the ISO Latin-1 (8859-1) character set..
402 val uncapitalize : string -> string
406 Deprecated. Functions operating on Latin-1 character set are depre‐
408 cated.
409 Return a copy of the argument, with the first character set to lower‐
412 case, using the ISO Latin-1 (8859-1) character set..
413 val uppercase_ascii : string -> string
417 Return a copy of the argument, with all lowercase letters translated to
419 uppercase, using the US-ASCII character set.
420 Since 4.03.0
423 val lowercase_ascii : string -> string
427 Return a copy of the argument, with all uppercase letters translated to
429 lowercase, using the US-ASCII character set.
430 Since 4.03.0
433 val capitalize_ascii : string -> string
437 Return a copy of the argument, with the first character set to upper‐
439 case, using the US-ASCII character set.
440 Since 4.03.0
443 val uncapitalize_ascii : string -> string
447 Return a copy of the argument, with the first character set to lower‐
449 case, using the US-ASCII character set.
450 Since 4.03.0
453 type t = string
456 An alias for the type of strings.
459 val compare : t -> t -> int
463 The comparison function for strings, with the same specification as
465 compare . Along with the type t , this function compare allows the
466 module String to be passed as argument to the functors Set.Make and
467 Map.Make .
468 val equal : t -> t -> bool
472 The equal function for strings.
474 Since 4.03.0
477 val split_on_char : char -> string -> string list
481 String.split_on_char sep s returns the list of all (possibly empty)
484 substrings of s that are delimited by the sep character.
485 The function's output is specified by the following invariants:
487 -The list is not empty.
490 -Concatenating its elements using sep as a separator returns a string
492 equal to the input ( String.concat (String.make 1 sep)
493 (String.split_on_char sep s) = s ).
494 -No string in the result contains the sep character.
496 Since 4.04.0
500 Iterators
505 val to_seq : t -> char Seq.t
506 Iterate on the string, in increasing index order. Modifications of the
508 string during iteration will be reflected in the iterator.
509 Since 4.07
512 val to_seqi : t -> (int * char) Seq.t
516 Iterate on the string, in increasing order, yielding indices along
518 chars
519 Since 4.07
522 val of_seq : char Seq.t -> t
526 Create a string from the generator
528 Since 4.07
531OCamldoc 2020-09-01 Stdlib.String(3)