1Stdlib.StringLabels(3) OCaml library Stdlib.StringLabels(3)
2
6 Stdlib.StringLabels - no description
7
9 Module Stdlib.StringLabels
10
12 Module StringLabels
13 : (module Stdlib__stringLabels)
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 BytesLabels.set .
42 String.set s n c modifies byte sequence s in place, replacing the byte
46 at index n with c . You can also write s.[n] <- c instead of
47 String.set s n c .
48 Raises Invalid_argument if n is not a valid index in s .
51 val create : int -> bytes
55 Deprecated. This is a deprecated alias of BytesLabels.create .
57 String.create n returns a fresh byte sequence of length n . The
61 sequence is uninitialized and contains arbitrary bytes.
62 Raises Invalid_argument if n < 0 or n > Sys.max_string_length .
65 val make : int -> char -> string
69 String.make n c returns a fresh string of length n , filled with the
72 character c .
73 Raises Invalid_argument if n < 0 or n > Sys.max_string_length .
76 val init : int -> f:(int -> char) -> string
80 init n f returns a string of length n , with character i initialized to
83 the result of f i .
84 Since 4.02.0
87 Raises Invalid_argument if n < 0 or n > Sys.max_string_length .
90 val copy : string -> string
94 Return a copy of the given string.
96 val sub : string -> pos:int -> len:int -> string
100 String.sub s start len returns a fresh string of length len , contain‐
103 ing the substring of s that starts at position start and has length len
104 .
105 Raises Invalid_argument if start and len do not designate a valid sub‐
108 string of s .
109 val fill : bytes -> pos:int -> len:int -> char -> unit
113 Deprecated. This is a deprecated alias of BytesLabels.fill .
115 String.fill s start len c modifies byte sequence s in place, replacing
119 len bytes by c , starting at start .
120 Raises Invalid_argument if start and len do not designate a valid sub‐
123 string of s .
124 val blit : src:string -> src_pos:int -> dst:bytes -> dst_pos:int ->
128 len:int -> unit
129 String.blit src srcoff dst dstoff len copies len bytes from the string
132 src , starting at index srcoff , to byte sequence dst , starting at
133 character number dstoff .
134 Raises Invalid_argument if srcoff and len do not designate a valid
137 range of src , or if dstoff and len do not designate a valid range of
138 dst .
139 val concat : sep:string -> string list -> string
143 String.concat sep sl concatenates the list of strings sl , inserting
146 the separator string sep between each.
147 val iter : f:(char -> unit) -> string -> unit
151 String.iter f s applies function f in turn to all the characters of s .
154 It is equivalent to f s.[0]; f s.[1]; ...; f s.[String.length s - 1];
155 () .
156 val iteri : f:(int -> char -> unit) -> string -> unit
160 Same as String.iter , but the function is applied to the index of the
162 element as first argument (counting from 0), and the character itself
163 as second argument.
164 Since 4.00.0
167 val map : f:(char -> char) -> string -> string
171 String.map f s applies function f in turn to all the characters of s
174 and stores the results in a new string that is returned.
175 Since 4.00.0
178 val mapi : f:(int -> char -> char) -> string -> string
182 String.mapi f s calls f with each character of s and its index (in
185 increasing index order) and stores the results in a new string that is
186 returned.
187 Since 4.02.0
190 val trim : string -> string
194 Return a copy of the argument, without leading and trailing whitespace.
196 The characters regarded as whitespace are: ' ' , '\012' , '\n' , '\r' ,
197 and '\t' . If there is no leading nor trailing whitespace character in
198 the argument, return the original string itself, not a copy.
199 Since 4.00.0
202 val escaped : string -> string
206 Return a copy of the argument, with special characters represented by
208 escape sequences, following the lexical conventions of OCaml. If there
209 is no special character in the argument, return the original string
210 itself, not a copy. Its inverse function is Scanf.unescaped.
211 val index : string -> char -> int
215 String.index s c returns the index of the first occurrence of character
218 c in string s .
219 Raises Not_found if c does not occur in s .
222 val index_opt : string -> char -> int option
226 String.index_opt s c returns the index of the first occurrence of char‐
229 acter c in string s , or None if c does not occur in s .
230 Since 4.05
233 val rindex : string -> char -> int
237 String.rindex s c returns the index of the last occurrence of character
240 c in string s .
241 Raises Not_found if c does not occur in s .
244 val rindex_opt : string -> char -> int option
248 String.rindex_opt s c returns the index of the last occurrence of char‐
251 acter c in string s , or None if c does not occur in s .
252 Since 4.05
255 val index_from : string -> int -> char -> int
259 String.index_from s i c returns the index of the first occurrence of
262 character c in string s after position i . String.index s c is equiva‐
263 lent to String.index_from s 0 c .
264 Raises Invalid_argument if i is not a valid position in s .
267 Raises Not_found if c does not occur in s after position i .
270 val index_from_opt : string -> int -> char -> int option
274 String.index_from_opt s i c returns the index of the first occurrence
277 of character c in string s after position i or None if c does not occur
278 in s after position i .
279 String.index_opt s c is equivalent to String.index_from_opt s 0 c .
282 Since 4.05
285 Raises Invalid_argument if i is not a valid position in s .
288 val rindex_from : string -> int -> char -> int
292 String.rindex_from s i c returns the index of the last occurrence of
295 character c in string s before position i+1 . String.rindex s c is
296 equivalent to String.rindex_from s (String.length s - 1) c .
297 Raises Invalid_argument if i+1 is not a valid position in s .
300 Raises Not_found if c does not occur in s before position i+1 .
303 val rindex_from_opt : string -> int -> char -> int option
307 String.rindex_from_opt s i c returns the index of the last occurrence
310 of character c in string s before position i+1 or None if c does not
311 occur in s before position i+1 .
312 String.rindex_opt s c is equivalent to String.rindex_from_opt s
315 (String.length s - 1) c .
316 Since 4.05
319 Raises Invalid_argument if i+1 is not a valid position in s .
322 val contains : string -> char -> bool
326 String.contains s c tests if character c appears in the string s .
329 val contains_from : string -> int -> char -> bool
333 String.contains_from s start c tests if character c appears in s after
336 position start . String.contains s c is equivalent to String.con‐
337 tains_from s 0 c .
338 Raises Invalid_argument if start is not a valid position in s .
341 val rcontains_from : string -> int -> char -> bool
345 String.rcontains_from s stop c tests if character c appears in s before
348 position stop+1 .
349 Raises Invalid_argument if stop < 0 or stop+1 is not a valid position
352 in s .
353 val uppercase : string -> string
357 Deprecated. Functions operating on Latin-1 character set are depre‐
359 cated.
360 Return a copy of the argument, with all lowercase letters translated to
363 uppercase, including accented letters of the ISO Latin-1 (8859-1) char‐
364 acter set.
365 val lowercase : string -> string
369 Deprecated. Functions operating on Latin-1 character set are depre‐
371 cated.
372 Return a copy of the argument, with all uppercase letters translated to
375 lowercase, including accented letters of the ISO Latin-1 (8859-1) char‐
376 acter set.
377 val capitalize : string -> string
381 Deprecated. Functions operating on Latin-1 character set are depre‐
383 cated.
384 Return a copy of the argument, with the first character set to upper‐
387 case, using the ISO Latin-1 (8859-1) character set..
388 val uncapitalize : string -> string
392 Deprecated. Functions operating on Latin-1 character set are depre‐
394 cated.
395 Return a copy of the argument, with the first character set to lower‐
398 case, using the ISO Latin-1 (8859-1) character set..
399 val uppercase_ascii : string -> string
403 Return a copy of the argument, with all lowercase letters translated to
405 uppercase, using the US-ASCII character set.
406 Since 4.05.0
409 val lowercase_ascii : string -> string
413 Return a copy of the argument, with all uppercase letters translated to
415 lowercase, using the US-ASCII character set.
416 Since 4.05.0
419 val capitalize_ascii : string -> string
423 Return a copy of the argument, with the first character set to upper‐
425 case, using the US-ASCII character set.
426 Since 4.05.0
429 val uncapitalize_ascii : string -> string
433 Return a copy of the argument, with the first character set to lower‐
435 case, using the US-ASCII character set.
436 Since 4.05.0
439 type t = string
442 An alias for the type of strings.
445 val compare : t -> t -> int
449 The comparison function for strings, with the same specification as
451 compare . Along with the type t , this function compare allows the
452 module String to be passed as argument to the functors Set.Make and
453 Map.Make .
454 val equal : t -> t -> bool
458 The equal function for strings.
460 Since 4.05.0
463 val split_on_char : sep:char -> string -> string list
467 String.split_on_char sep s returns the list of all (possibly empty)
470 substrings of s that are delimited by the sep character.
471 The function's output is specified by the following invariants:
473 -The list is not empty.
476 -Concatenating its elements using sep as a separator returns a string
478 equal to the input ( String.concat (String.make 1 sep)
479 (String.split_on_char sep s) = s ).
480 -No string in the result contains the sep character.
482 Since 4.05.0
486 Iterators
491 val to_seq : t -> char Seq.t
492 Iterate on the string, in increasing index order. Modifications of the
494 string during iteration will be reflected in the iterator.
495 Since 4.07
498 val to_seqi : t -> (int * char) Seq.t
502 Iterate on the string, in increasing order, yielding indices along
504 chars
505 Since 4.07
508 val of_seq : char Seq.t -> t
512 Create a string from the generator
514 Since 4.07
517OCamldoc 2020-09-01 Stdlib.StringLabels(3)