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 Raise Invalid_argument if n not a valid index in s .
35 val set : bytes -> int -> char -> unit
39 Deprecated. This is a deprecated alias of BytesLabels.set .
41 String.set s n c modifies byte sequence s in place, replacing the byte
45 at index n with c . You can also write s.[n] <- c instead of
46 String.set s n c .
47 Raise Invalid_argument if n is not a valid index in s .
49 val create : int -> bytes
53 Deprecated. This is a deprecated alias of BytesLabels.create .
55 String.create n returns a fresh byte sequence of length n . The
59 sequence is uninitialized and contains arbitrary bytes.
60 Raise Invalid_argument if n < 0 or n > Sys.max_string_length .
62 val make : int -> char -> string
66 String.make n c returns a fresh string of length n , filled with the
69 character c .
70 Raise Invalid_argument if n < 0 or n > Sys.max_string_length .
72 val init : int -> f:(int -> char) -> string
76 init n f returns a string of length n , with character i initialized to
79 the result of f i .
80 Raise Invalid_argument if n < 0 or n > Sys.max_string_length .
82 Since 4.02.0
85 val copy : string -> string
89 Return a copy of the given string.
91 val sub : string -> pos:int -> len:int -> string
95 String.sub s start len returns a fresh string of length len , contain‐
98 ing the substring of s that starts at position start and has length len
99 .
100 Raise Invalid_argument if start and len do not designate a valid sub‐
102 string of s .
103 val fill : bytes -> pos:int -> len:int -> char -> unit
107 Deprecated. This is a deprecated alias of BytesLabels.fill .
109 String.fill s start len c modifies byte sequence s in place, replacing
113 len bytes by c , starting at start .
114 Raise Invalid_argument if start and len do not designate a valid sub‐
116 string of s .
117 val blit : src:string -> src_pos:int -> dst:bytes -> dst_pos:int ->
121 len:int -> unit
122 String.blit src srcoff dst dstoff len copies len bytes from the string
125 src , starting at index srcoff , to byte sequence dst , starting at
126 character number dstoff .
127 Raise Invalid_argument if srcoff and len do not designate a valid range
129 of src , or if dstoff and len do not designate a valid range of dst .
130 val concat : sep:string -> string list -> string
134 String.concat sep sl concatenates the list of strings sl , inserting
137 the separator string sep between each.
138 val iter : f:(char -> unit) -> string -> unit
142 String.iter f s applies function f in turn to all the characters of s .
145 It is equivalent to f s.[0]; f s.[1]; ...; f s.[String.length s - 1];
146 () .
147 val iteri : f:(int -> char -> unit) -> string -> unit
151 Same as String.iter , but the function is applied to the index of the
153 element as first argument (counting from 0), and the character itself
154 as second argument.
155 Since 4.00.0
158 val map : f:(char -> char) -> string -> string
162 String.map f s applies function f in turn to all the characters of s
165 and stores the results in a new string that is returned.
166 Since 4.00.0
169 val mapi : f:(int -> char -> char) -> string -> string
173 String.mapi f s calls f with each character of s and its index (in
176 increasing index order) and stores the results in a new string that is
177 returned.
178 Since 4.02.0
181 val trim : string -> string
185 Return a copy of the argument, without leading and trailing whitespace.
187 The characters regarded as whitespace are: ' ' , '\012' , '\n' , '\r' ,
188 and '\t' . If there is no leading nor trailing whitespace character in
189 the argument, return the original string itself, not a copy.
190 Since 4.00.0
193 val escaped : string -> string
197 Return a copy of the argument, with special characters represented by
199 escape sequences, following the lexical conventions of OCaml. If there
200 is no special character in the argument, return the original string
201 itself, not a copy. Its inverse function is Scanf.unescaped.
202 val index : string -> char -> int
206 String.index s c returns the index of the first occurrence of character
209 c in string s .
210 Raise Not_found if c does not occur in s .
212 val index_opt : string -> char -> int option
216 String.index_opt s c returns the index of the first occurrence of char‐
219 acter c in string s , or None if c does not occur in s .
220 Since 4.05
223 val rindex : string -> char -> int
227 String.rindex s c returns the index of the last occurrence of character
230 c in string s .
231 Raise Not_found if c does not occur in s .
233 val rindex_opt : string -> char -> int option
237 String.rindex_opt s c returns the index of the last occurrence of char‐
240 acter c in string s , or None if c does not occur in s .
241 Since 4.05
244 val index_from : string -> int -> char -> int
248 String.index_from s i c returns the index of the first occurrence of
251 character c in string s after position i . String.index s c is equiva‐
252 lent to String.index_from s 0 c .
253 Raise Invalid_argument if i is not a valid position in s . Raise
255 Not_found if c does not occur in s after position i .
256 val index_from_opt : string -> int -> char -> int option
260 String.index_from_opt s i c returns the index of the first occurrence
263 of character c in string s after position i or None if c does not occur
264 in s after position i .
265 String.index_opt s c is equivalent to String.index_from_opt s 0 c .
268 Raise Invalid_argument if i is not a valid position in s .
269 Since 4.05
272 val rindex_from : string -> int -> char -> int
276 String.rindex_from s i c returns the index of the last occurrence of
279 character c in string s before position i+1 . String.rindex s c is
280 equivalent to String.rindex_from s (String.length s - 1) c .
281 Raise Invalid_argument if i+1 is not a valid position in s . Raise
283 Not_found if c does not occur in s before position i+1 .
284 val rindex_from_opt : string -> int -> char -> int option
288 String.rindex_from_opt s i c returns the index of the last occurrence
291 of character c in string s before position i+1 or None if c does not
292 occur in s before position i+1 .
293 String.rindex_opt s c is equivalent to String.rindex_from_opt s
296 (String.length s - 1) c .
297 Raise Invalid_argument if i+1 is not a valid position in s .
299 Since 4.05
302 val contains : string -> char -> bool
306 String.contains s c tests if character c appears in the string s .
309 val contains_from : string -> int -> char -> bool
313 String.contains_from s start c tests if character c appears in s after
316 position start . String.contains s c is equivalent to String.con‐
317 tains_from s 0 c .
318 Raise Invalid_argument if start is not a valid position in s .
320 val rcontains_from : string -> int -> char -> bool
324 String.rcontains_from s stop c tests if character c appears in s before
327 position stop+1 .
328 Raise Invalid_argument if stop < 0 or stop+1 is not a valid position in
330 s .
331 val uppercase : string -> string
335 Deprecated. Functions operating on Latin-1 character set are depre‐
337 cated.
338 Return a copy of the argument, with all lowercase letters translated to
341 uppercase, including accented letters of the ISO Latin-1 (8859-1) char‐
342 acter set.
343 val lowercase : string -> string
347 Deprecated. Functions operating on Latin-1 character set are depre‐
349 cated.
350 Return a copy of the argument, with all uppercase letters translated to
353 lowercase, including accented letters of the ISO Latin-1 (8859-1) char‐
354 acter set.
355 val capitalize : string -> string
359 Deprecated. Functions operating on Latin-1 character set are depre‐
361 cated.
362 Return a copy of the argument, with the first character set to upper‐
365 case, using the ISO Latin-1 (8859-1) character set..
366 val uncapitalize : string -> string
370 Deprecated. Functions operating on Latin-1 character set are depre‐
372 cated.
373 Return a copy of the argument, with the first character set to lower‐
376 case, using the ISO Latin-1 (8859-1) character set..
377 val uppercase_ascii : string -> string
381 Return a copy of the argument, with all lowercase letters translated to
383 uppercase, using the US-ASCII character set.
384 Since 4.05.0
387 val lowercase_ascii : string -> string
391 Return a copy of the argument, with all uppercase letters translated to
393 lowercase, using the US-ASCII character set.
394 Since 4.05.0
397 val capitalize_ascii : string -> string
401 Return a copy of the argument, with the first character set to upper‐
403 case, using the US-ASCII character set.
404 Since 4.05.0
407 val uncapitalize_ascii : string -> string
411 Return a copy of the argument, with the first character set to lower‐
413 case, using the US-ASCII character set.
414 Since 4.05.0
417 type t = string
420 An alias for the type of strings.
423 val compare : t -> t -> int
427 The comparison function for strings, with the same specification as
429 compare . Along with the type t , this function compare allows the
430 module String to be passed as argument to the functors Set.Make and
431 Map.Make .
432 val equal : t -> t -> bool
436 The equal function for strings.
438 Since 4.05.0
441 val split_on_char : sep:char -> string -> string list
445 String.split_on_char sep s returns the list of all (possibly empty)
448 substrings of s that are delimited by the sep character.
449 The function's output is specified by the following invariants:
451 -The list is not empty.
454 -Concatenating its elements using sep as a separator returns a string
456 equal to the input ( String.concat (String.make 1 sep)
457 (String.split_on_char sep s) = s ).
458 -No string in the result contains the sep character.
460 Since 4.05.0
464 Iterators
469 val to_seq : t -> char Seq.t
470 Iterate on the string, in increasing index order. Modifications of the
472 string during iteration will be reflected in the iterator.
473 Since 4.07
476 val to_seqi : t -> (int * char) Seq.t
480 Iterate on the string, in increasing order, yielding indices along
482 chars
483 Since 4.07
486 val of_seq : char Seq.t -> t
490 Create a string from the generator
492 Since 4.07
495OCamldoc 2019-07-30 Stdlib.StringLabels(3)