1StdLabels.Bytes(3) OCamldoc StdLabels.Bytes(3)
2
6 StdLabels.Bytes - no description
7
9 Module StdLabels.Bytes
10
12 Module Bytes
13 : (module BytesLabels)
14 val length : bytes -> int
23 Return the length (number of bytes) of the argument.
25 val get : bytes -> int -> char
29 get s n returns the byte at index n in argument s .
32 Raise Invalid_argument if n is not a valid index in s .
34 val set : bytes -> int -> char -> unit
38 set s n c modifies s in place, replacing the byte at index n with c .
41 Raise Invalid_argument if n is not a valid index in s .
43 val create : int -> bytes
47 create n returns a new byte sequence of length n . The sequence is
50 uninitialized and contains arbitrary bytes.
51 Raise Invalid_argument if n < 0 or n > Sys.max_string_length .
53 val make : int -> char -> bytes
57 make n c returns a new byte sequence of length n , filled with the byte
60 c .
61 Raise Invalid_argument if n < 0 or n > Sys.max_string_length .
63 val init : int -> f:(int -> char) -> bytes
67 init n f returns a fresh byte sequence of length n , with character i
70 initialized to the result of f i .
71 Raise Invalid_argument if n < 0 or n > Sys.max_string_length .
73 val empty : bytes
77 A byte sequence of size 0.
79 val copy : bytes -> bytes
83 Return a new byte sequence that contains the same bytes as the argu‐
85 ment.
86 val of_string : string -> bytes
90 Return a new byte sequence that contains the same bytes as the given
92 string.
93 val to_string : bytes -> string
97 Return a new string that contains the same bytes as the given byte
99 sequence.
100 val sub : bytes -> pos:int -> len:int -> bytes
104 sub s start len returns a new byte sequence of length len , containing
107 the subsequence of s that starts at position start and has length len .
108 Raise Invalid_argument if start and len do not designate a valid range
110 of s .
111 val sub_string : bytes -> int -> int -> string
115 Same as sub but return a string instead of a byte sequence.
117 val extend : bytes -> left:int -> right:int -> bytes
121 extend s left right returns a new byte sequence that contains the bytes
124 of s , with left uninitialized bytes prepended and right uninitialized
125 bytes appended to it. If left or right is negative, then bytes are
126 removed (instead of appended) from the corresponding side of s .
127 Raise Invalid_argument if the result length is negative or longer than
129 Sys.max_string_length bytes.
130 Since 4.05.0
133 val fill : bytes -> pos:int -> len:int -> char -> unit
137 fill s start len c modifies s in place, replacing len characters with c
140 , starting at start .
141 Raise Invalid_argument if start and len do not designate a valid range
143 of s .
144 val blit : src:bytes -> src_pos:int -> dst:bytes -> dst_pos:int ->
148 len:int -> unit
149 blit src srcoff dst dstoff len copies len bytes from sequence src ,
152 starting at index srcoff , to sequence dst , starting at index dstoff .
153 It works correctly even if src and dst are the same byte sequence, and
154 the source and destination intervals overlap.
155 Raise Invalid_argument if srcoff and len do not designate a valid range
157 of src , or if dstoff and len do not designate a valid range of dst .
158 val blit_string : src:string -> src_pos:int -> dst:bytes -> dst_pos:int
162 -> len:int -> unit
163 blit src srcoff dst dstoff len copies len bytes from string src ,
166 starting at index srcoff , to byte sequence dst , starting at index
167 dstoff .
168 Raise Invalid_argument if srcoff and len do not designate a valid range
170 of src , or if dstoff and len do not designate a valid range of dst .
171 Since 4.05.0
174 val concat : sep:bytes -> bytes list -> bytes
178 concat sep sl concatenates the list of byte sequences sl , inserting
181 the separator byte sequence sep between each, and returns the result as
182 a new byte sequence.
183 val cat : bytes -> bytes -> bytes
187 cat s1 s2 concatenates s1 and s2 and returns the result as new byte
190 sequence.
191 Raise Invalid_argument if the result is longer than
193 Sys.max_string_length bytes.
194 Since 4.05.0
197 val iter : f:(char -> unit) -> bytes -> unit
201 iter f s applies function f in turn to all the bytes of s . It is
204 equivalent to f (get s 0); f (get s 1); ...; f (get s (length s - 1));
205 () .
206 val iteri : f:(int -> char -> unit) -> bytes -> unit
210 Same as Bytes.iter , but the function is applied to the index of the
212 byte as first argument and the byte itself as second argument.
213 val map : f:(char -> char) -> bytes -> bytes
217 map f s applies function f in turn to all the bytes of s and stores the
220 resulting bytes in a new sequence that is returned as the result.
221 val mapi : f:(int -> char -> char) -> bytes -> bytes
225 mapi f s calls f with each character of s and its index (in increasing
228 index order) and stores the resulting bytes in a new sequence that is
229 returned as the result.
230 val trim : bytes -> bytes
234 Return a copy of the argument, without leading and trailing whitespace.
236 The bytes regarded as whitespace are the ASCII characters ' ' , '\012'
237 , '\n' , '\r' , and '\t' .
238 val escaped : bytes -> bytes
242 Return a copy of the argument, with special characters represented by
244 escape sequences, following the lexical conventions of OCaml.
245 val index : bytes -> char -> int
249 index s c returns the index of the first occurrence of byte c in s .
252 Raise Not_found if c does not occur in s .
254 val index_opt : bytes -> char -> int option
258 index_opt s c returns the index of the first occurrence of byte c in s
261 or None if c does not occur in s .
262 Since 4.05
265 val rindex : bytes -> char -> int
269 rindex s c returns the index of the last occurrence of byte c in s .
272 Raise Not_found if c does not occur in s .
274 val rindex_opt : bytes -> char -> int option
278 rindex_opt s c returns the index of the last occurrence of byte c in s
281 or None if c does not occur in s .
282 Since 4.05
285 val index_from : bytes -> int -> char -> int
289 index_from s i c returns the index of the first occurrence of byte c in
292 s after position i . Bytes.index s c is equivalent to Bytes.index_from
293 s 0 c .
294 Raise Invalid_argument if i is not a valid position in s . Raise
296 Not_found if c does not occur in s after position i .
297 val index_from_opt : bytes -> int -> char -> int option
301 index_from _opts i c returns the index of the first occurrence of byte
304 c in s after position i or None if c does not occur in s after position
305 i . Bytes.index_opt s c is equivalent to Bytes.index_from_opt s 0 c .
306 Raise Invalid_argument if i is not a valid position in s .
308 Since 4.05
311 val rindex_from : bytes -> int -> char -> int
315 rindex_from s i c returns the index of the last occurrence of byte c in
318 s before position i+1 . rindex s c is equivalent to rindex_from s
319 (Bytes.length s - 1) c .
320 Raise Invalid_argument if i+1 is not a valid position in s . Raise
322 Not_found if c does not occur in s before position i+1 .
323 val rindex_from_opt : bytes -> int -> char -> int option
327 rindex_from_opt s i c returns the index of the last occurrence of byte
330 c in s before position i+1 or None if c does not occur in s before
331 position i+1 . rindex_opt s c is equivalent to rindex_from s
332 (Bytes.length s - 1) c .
333 Raise Invalid_argument if i+1 is not a valid position in s .
335 Since 4.05
338 val contains : bytes -> char -> bool
342 contains s c tests if byte c appears in s .
345 val contains_from : bytes -> int -> char -> bool
349 contains_from s start c tests if byte c appears in s after position
352 start . contains s c is equivalent to contains_from s 0 c .
353 Raise Invalid_argument if start is not a valid position in s .
355 val rcontains_from : bytes -> int -> char -> bool
359 rcontains_from s stop c tests if byte c appears in s before position
362 stop+1 .
363 Raise Invalid_argument if stop < 0 or stop+1 is not a valid position in
365 s .
366 val uppercase : bytes -> bytes
370 Deprecated. Functions operating on Latin-1 character set are depre‐
372 cated.
373 Return a copy of the argument, with all lowercase letters translated to
376 uppercase, including accented letters of the ISO Latin-1 (8859-1) char‐
377 acter set.
378 val lowercase : bytes -> bytes
382 Deprecated. Functions operating on Latin-1 character set are depre‐
384 cated.
385 Return a copy of the argument, with all uppercase letters translated to
388 lowercase, including accented letters of the ISO Latin-1 (8859-1) char‐
389 acter set.
390 val capitalize : bytes -> bytes
394 Deprecated. Functions operating on Latin-1 character set are depre‐
396 cated.
397 Return a copy of the argument, with the first character set to upper‐
400 case, using the ISO Latin-1 (8859-1) character set..
401 val uncapitalize : bytes -> bytes
405 Deprecated. Functions operating on Latin-1 character set are depre‐
407 cated.
408 Return a copy of the argument, with the first character set to lower‐
411 case, using the ISO Latin-1 (8859-1) character set..
412 val uppercase_ascii : bytes -> bytes
416 Return a copy of the argument, with all lowercase letters translated to
418 uppercase, using the US-ASCII character set.
419 Since 4.05.0
422 val lowercase_ascii : bytes -> bytes
426 Return a copy of the argument, with all uppercase letters translated to
428 lowercase, using the US-ASCII character set.
429 Since 4.05.0
432 val capitalize_ascii : bytes -> bytes
436 Return a copy of the argument, with the first character set to upper‐
438 case, using the US-ASCII character set.
439 Since 4.05.0
442 val uncapitalize_ascii : bytes -> bytes
446 Return a copy of the argument, with the first character set to lower‐
448 case, using the US-ASCII character set.
449 Since 4.05.0
452 type t = bytes
455 An alias for the type of byte sequences.
458 val compare : t -> t -> int
462 The comparison function for byte sequences, with the same specification
464 as Pervasives.compare . Along with the type t , this function compare
465 allows the module Bytes to be passed as argument to the functors
466 Set.Make and Map.Make .
467 val equal : t -> t -> bool
471 The equality function for byte sequences.
473 Since 4.05.0
4762018-04-14 source: StdLabels.Bytes(3)