1BytesLabels(3) OCaml library BytesLabels(3)
2
6 BytesLabels - Byte sequence operations.
7
9 Module BytesLabels
10
12 Module BytesLabels
13 : sig end
14 Byte sequence operations.
17 Since 4.02.0
20 val length : bytes -> int
27 Return the length (number of bytes) of the argument.
29 val get : bytes -> int -> char
33 get s n returns the byte at index n in argument s .
36 Raise Invalid_argument if n is not a valid index in s .
38 val set : bytes -> int -> char -> unit
42 set s n c modifies s in place, replacing the byte at index n with c .
45 Raise Invalid_argument if n is not a valid index in s .
47 val create : int -> bytes
51 create n returns a new byte sequence of length n . The sequence is
54 uninitialized and contains arbitrary bytes.
55 Raise Invalid_argument if n < 0 or n > Sys.max_string_length .
57 val make : int -> char -> bytes
61 make n c returns a new byte sequence of length n , filled with the byte
64 c .
65 Raise Invalid_argument if n < 0 or n > Sys.max_string_length .
67 val init : int -> f:(int -> char) -> bytes
71 init n f returns a fresh byte sequence of length n , with character i
74 initialized to the result of f i .
75 Raise Invalid_argument if n < 0 or n > Sys.max_string_length .
77 val empty : bytes
81 A byte sequence of size 0.
83 val copy : bytes -> bytes
87 Return a new byte sequence that contains the same bytes as the argu‐
89 ment.
90 val of_string : string -> bytes
94 Return a new byte sequence that contains the same bytes as the given
96 string.
97 val to_string : bytes -> string
101 Return a new string that contains the same bytes as the given byte
103 sequence.
104 val sub : bytes -> pos:int -> len:int -> bytes
108 sub s start len returns a new byte sequence of length len , containing
111 the subsequence of s that starts at position start and has length len .
112 Raise Invalid_argument if start and len do not designate a valid range
114 of s .
115 val sub_string : bytes -> pos:int -> len:int -> string
119 Same as sub but return a string instead of a byte sequence.
121 val extend : bytes -> left:int -> right:int -> bytes
125 extend s left right returns a new byte sequence that contains the bytes
128 of s , with left uninitialized bytes prepended and right uninitialized
129 bytes appended to it. If left or right is negative, then bytes are
130 removed (instead of appended) from the corresponding side of s .
131 Raise Invalid_argument if the result length is negative or longer than
133 Sys.max_string_length bytes.
134 Since 4.05.0
137 val fill : bytes -> pos:int -> len:int -> char -> unit
141 fill s start len c modifies s in place, replacing len characters with c
144 , starting at start .
145 Raise Invalid_argument if start and len do not designate a valid range
147 of s .
148 val blit : src:bytes -> src_pos:int -> dst:bytes -> dst_pos:int ->
152 len:int -> unit
153 blit src srcoff dst dstoff len copies len bytes from sequence src ,
156 starting at index srcoff , to sequence dst , starting at index dstoff .
157 It works correctly even if src and dst are the same byte sequence, and
158 the source and destination intervals overlap.
159 Raise Invalid_argument if srcoff and len do not designate a valid range
161 of src , or if dstoff and len do not designate a valid range of dst .
162 val blit_string : src:string -> src_pos:int -> dst:bytes -> dst_pos:int
166 -> len:int -> unit
167 blit src srcoff dst dstoff len copies len bytes from string src ,
170 starting at index srcoff , to byte sequence dst , starting at index
171 dstoff .
172 Raise Invalid_argument if srcoff and len do not designate a valid range
174 of src , or if dstoff and len do not designate a valid range of dst .
175 Since 4.05.0
178 val concat : sep:bytes -> bytes list -> bytes
182 concat sep sl concatenates the list of byte sequences sl , inserting
185 the separator byte sequence sep between each, and returns the result as
186 a new byte sequence.
187 val cat : bytes -> bytes -> bytes
191 cat s1 s2 concatenates s1 and s2 and returns the result as new byte
194 sequence.
195 Raise Invalid_argument if the result is longer than
197 Sys.max_string_length bytes.
198 Since 4.05.0
201 val iter : f:(char -> unit) -> bytes -> unit
205 iter f s applies function f in turn to all the bytes of s . It is
208 equivalent to f (get s 0); f (get s 1); ...; f (get s (length s - 1));
209 () .
210 val iteri : f:(int -> char -> unit) -> bytes -> unit
214 Same as Bytes.iter , but the function is applied to the index of the
216 byte as first argument and the byte itself as second argument.
217 val map : f:(char -> char) -> bytes -> bytes
221 map f s applies function f in turn to all the bytes of s and stores the
224 resulting bytes in a new sequence that is returned as the result.
225 val mapi : f:(int -> char -> char) -> bytes -> bytes
229 mapi f s calls f with each character of s and its index (in increasing
232 index order) and stores the resulting bytes in a new sequence that is
233 returned as the result.
234 val trim : bytes -> bytes
238 Return a copy of the argument, without leading and trailing whitespace.
240 The bytes regarded as whitespace are the ASCII characters ' ' , '\012'
241 , '\n' , '\r' , and '\t' .
242 val escaped : bytes -> bytes
246 Return a copy of the argument, with special characters represented by
248 escape sequences, following the lexical conventions of OCaml.
249 val index : bytes -> char -> int
253 index s c returns the index of the first occurrence of byte c in s .
256 Raise Not_found if c does not occur in s .
258 val index_opt : bytes -> char -> int option
262 index_opt s c returns the index of the first occurrence of byte c in s
265 or None if c does not occur in s .
266 Since 4.05
269 val rindex : bytes -> char -> int
273 rindex s c returns the index of the last occurrence of byte c in s .
276 Raise Not_found if c does not occur in s .
278 val rindex_opt : bytes -> char -> int option
282 rindex_opt s c returns the index of the last occurrence of byte c in s
285 or None if c does not occur in s .
286 Since 4.05
289 val index_from : bytes -> int -> char -> int
293 index_from s i c returns the index of the first occurrence of byte c in
296 s after position i . Bytes.index s c is equivalent to Bytes.index_from
297 s 0 c .
298 Raise Invalid_argument if i is not a valid position in s . Raise
300 Not_found if c does not occur in s after position i .
301 val index_from_opt : bytes -> int -> char -> int option
305 index_from _opts i c returns the index of the first occurrence of byte
308 c in s after position i or None if c does not occur in s after position
309 i . Bytes.index_opt s c is equivalent to Bytes.index_from_opt s 0 c .
310 Raise Invalid_argument if i is not a valid position in s .
312 Since 4.05
315 val rindex_from : bytes -> int -> char -> int
319 rindex_from s i c returns the index of the last occurrence of byte c in
322 s before position i+1 . rindex s c is equivalent to rindex_from s
323 (Bytes.length s - 1) c .
324 Raise Invalid_argument if i+1 is not a valid position in s . Raise
326 Not_found if c does not occur in s before position i+1 .
327 val rindex_from_opt : bytes -> int -> char -> int option
331 rindex_from_opt s i c returns the index of the last occurrence of byte
334 c in s before position i+1 or None if c does not occur in s before
335 position i+1 . rindex_opt s c is equivalent to rindex_from s
336 (Bytes.length s - 1) c .
337 Raise Invalid_argument if i+1 is not a valid position in s .
339 Since 4.05
342 val contains : bytes -> char -> bool
346 contains s c tests if byte c appears in s .
349 val contains_from : bytes -> int -> char -> bool
353 contains_from s start c tests if byte c appears in s after position
356 start . contains s c is equivalent to contains_from s 0 c .
357 Raise Invalid_argument if start is not a valid position in s .
359 val rcontains_from : bytes -> int -> char -> bool
363 rcontains_from s stop c tests if byte c appears in s before position
366 stop+1 .
367 Raise Invalid_argument if stop < 0 or stop+1 is not a valid position in
369 s .
370 val uppercase : bytes -> bytes
374 Deprecated. Functions operating on Latin-1 character set are depre‐
376 cated.
377 Return a copy of the argument, with all lowercase letters translated to
380 uppercase, including accented letters of the ISO Latin-1 (8859-1) char‐
381 acter set.
382 val lowercase : bytes -> bytes
386 Deprecated. Functions operating on Latin-1 character set are depre‐
388 cated.
389 Return a copy of the argument, with all uppercase letters translated to
392 lowercase, including accented letters of the ISO Latin-1 (8859-1) char‐
393 acter set.
394 val capitalize : bytes -> bytes
398 Deprecated. Functions operating on Latin-1 character set are depre‐
400 cated.
401 Return a copy of the argument, with the first character set to upper‐
404 case, using the ISO Latin-1 (8859-1) character set..
405 val uncapitalize : bytes -> bytes
409 Deprecated. Functions operating on Latin-1 character set are depre‐
411 cated.
412 Return a copy of the argument, with the first character set to lower‐
415 case, using the ISO Latin-1 (8859-1) character set..
416 val uppercase_ascii : bytes -> bytes
420 Return a copy of the argument, with all lowercase letters translated to
422 uppercase, using the US-ASCII character set.
423 Since 4.05.0
426 val lowercase_ascii : bytes -> bytes
430 Return a copy of the argument, with all uppercase letters translated to
432 lowercase, using the US-ASCII character set.
433 Since 4.05.0
436 val capitalize_ascii : bytes -> bytes
440 Return a copy of the argument, with the first character set to upper‐
442 case, using the US-ASCII character set.
443 Since 4.05.0
446 val uncapitalize_ascii : bytes -> bytes
450 Return a copy of the argument, with the first character set to lower‐
452 case, using the US-ASCII character set.
453 Since 4.05.0
456 type t = bytes
459 An alias for the type of byte sequences.
462 val compare : t -> t -> int
466 The comparison function for byte sequences, with the same specification
468 as compare . Along with the type t , this function compare allows the
469 module Bytes to be passed as argument to the functors Set.Make and
470 Map.Make .
471 val equal : t -> t -> bool
475 The equality function for byte sequences.
477 Since 4.05.0
480 Iterators
485 val to_seq : t -> char Seq.t
486 Iterate on the string, in increasing index order. Modifications of the
488 string during iteration will be reflected in the iterator.
489 Since 4.07
492 val to_seqi : t -> (int * char) Seq.t
496 Iterate on the string, in increasing order, yielding indices along
498 chars
499 Since 4.07
502 val of_seq : char Seq.t -> t
506 Create a string from the generator
508 Since 4.07
511 Binary encoding/decoding of integers
516 The functions in this section binary encode and decode integers to and
517 from byte sequences.
518 All following functions raise Invalid_argument if the space needed at
520 index i to decode or encode the integer is not available.
521 Little-endian (resp. big-endian) encoding means that least (resp. most)
523 significant bytes are stored first. Big-endian is also known as net‐
524 work byte order. Native-endian encoding is either little-endian or
525 big-endian depending on Sys.big_endian .
526 32-bit and 64-bit integers are represented by the int32 and int64
528 types, which can be interpreted either as signed or unsigned numbers.
529 8-bit and 16-bit integers are represented by the int type, which has
531 more bits than the binary encoding. These extra bits are handled as
532 follows:
533 -Functions that decode signed (resp. unsigned) 8-bit or 16-bit integers
535 represented by int values sign-extend (resp. zero-extend) their result.
536 -Functions that encode 8-bit or 16-bit integers represented by int val‐
538 ues truncate their input to their least significant bytes.
539 val get_uint8 : bytes -> int -> int
542 get_uint8 b i is b 's unsigned 8-bit integer starting at byte index i .
545 Since 4.08
548 val get_int8 : bytes -> int -> int
552 get_int8 b i is b 's signed 8-bit integer starting at byte index i .
555 Since 4.08
558 val get_uint16_ne : bytes -> int -> int
562 get_uint16_ne b i is b 's native-endian unsigned 16-bit integer start‐
565 ing at byte index i .
566 Since 4.08
569 val get_uint16_be : bytes -> int -> int
573 get_uint16_be b i is b 's big-endian unsigned 16-bit integer starting
576 at byte index i .
577 Since 4.08
580 val get_uint16_le : bytes -> int -> int
584 get_uint16_le b i is b 's little-endian unsigned 16-bit integer start‐
587 ing at byte index i .
588 Since 4.08
591 val get_int16_ne : bytes -> int -> int
595 get_int16_ne b i is b 's native-endian signed 16-bit integer starting
598 at byte index i .
599 Since 4.08
602 val get_int16_be : bytes -> int -> int
606 get_int16_be b i is b 's big-endian signed 16-bit integer starting at
609 byte index i .
610 Since 4.08
613 val get_int16_le : bytes -> int -> int
617 get_int16_le b i is b 's little-endian signed 16-bit integer starting
620 at byte index i .
621 Since 4.08
624 val get_int32_ne : bytes -> int -> int32
628 get_int32_ne b i is b 's native-endian 32-bit integer starting at byte
631 index i .
632 Since 4.08
635 val get_int32_be : bytes -> int -> int32
639 get_int32_be b i is b 's big-endian 32-bit integer starting at byte
642 index i .
643 Since 4.08
646 val get_int32_le : bytes -> int -> int32
650 get_int32_le b i is b 's little-endian 32-bit integer starting at byte
653 index i .
654 Since 4.08
657 val get_int64_ne : bytes -> int -> int64
661 get_int64_ne b i is b 's native-endian 64-bit integer starting at byte
664 index i .
665 Since 4.08
668 val get_int64_be : bytes -> int -> int64
672 get_int64_be b i is b 's big-endian 64-bit integer starting at byte
675 index i .
676 Since 4.08
679 val get_int64_le : bytes -> int -> int64
683 get_int64_le b i is b 's little-endian 64-bit integer starting at byte
686 index i .
687 Since 4.08
690 val set_uint8 : bytes -> int -> int -> unit
694 set_uint8 b i v sets b 's unsigned 8-bit integer starting at byte index
697 i to v .
698 Since 4.08
701 val set_int8 : bytes -> int -> int -> unit
705 set_int8 b i v sets b 's signed 8-bit integer starting at byte index i
708 to v .
709 Since 4.08
712 val set_uint16_ne : bytes -> int -> int -> unit
716 set_uint16_ne b i v sets b 's native-endian unsigned 16-bit integer
719 starting at byte index i to v .
720 Since 4.08
723 val set_uint16_be : bytes -> int -> int -> unit
727 set_uint16_be b i v sets b 's big-endian unsigned 16-bit integer start‐
730 ing at byte index i to v .
731 Since 4.08
734 val set_uint16_le : bytes -> int -> int -> unit
738 set_uint16_le b i v sets b 's little-endian unsigned 16-bit integer
741 starting at byte index i to v .
742 Since 4.08
745 val set_int16_ne : bytes -> int -> int -> unit
749 set_int16_ne b i v sets b 's native-endian signed 16-bit integer start‐
752 ing at byte index i to v .
753 Since 4.08
756 val set_int16_be : bytes -> int -> int -> unit
760 set_int16_be b i v sets b 's big-endian signed 16-bit integer starting
763 at byte index i to v .
764 Since 4.08
767 val set_int16_le : bytes -> int -> int -> unit
771 set_int16_le b i v sets b 's little-endian signed 16-bit integer start‐
774 ing at byte index i to v .
775 Since 4.08
778 val set_int32_ne : bytes -> int -> int32 -> unit
782 set_int32_ne b i v sets b 's native-endian 32-bit integer starting at
785 byte index i to v .
786 Since 4.08
789 val set_int32_be : bytes -> int -> int32 -> unit
793 set_int32_be b i v sets b 's big-endian 32-bit integer starting at byte
796 index i to v .
797 Since 4.08
800 val set_int32_le : bytes -> int -> int32 -> unit
804 set_int32_le b i v sets b 's little-endian 32-bit integer starting at
807 byte index i to v .
808 Since 4.08
811 val set_int64_ne : bytes -> int -> int64 -> unit
815 set_int64_ne b i v sets b 's native-endian 64-bit integer starting at
818 byte index i to v .
819 Since 4.08
822 val set_int64_be : bytes -> int -> int64 -> unit
826 set_int64_be b i v sets b 's big-endian 64-bit integer starting at byte
829 index i to v .
830 Since 4.08
833 val set_int64_le : bytes -> int -> int64 -> unit
837 set_int64_le b i v sets b 's little-endian 64-bit integer starting at
840 byte index i to v .
841 Since 4.08
844OCamldoc 2019-07-30 BytesLabels(3)