1Stdlib.BytesLabels(3) OCaml library Stdlib.BytesLabels(3)
2
6 Stdlib.BytesLabels - no description
7
9 Module Stdlib.BytesLabels
10
12 Module BytesLabels
13 : (module Stdlib__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 Raises Invalid_argument if n is not a valid index in s .
35 val set : bytes -> int -> char -> unit
39 set s n c modifies s in place, replacing the byte at index n with c .
42 Raises Invalid_argument if n is not a valid index in s .
45 val create : int -> bytes
49 create n returns a new byte sequence of length n . The sequence is
52 uninitialized and contains arbitrary bytes.
53 Raises Invalid_argument if n < 0 or n > Sys.max_string_length .
56 val make : int -> char -> bytes
60 make n c returns a new byte sequence of length n , filled with the byte
63 c .
64 Raises 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 Raises Invalid_argument if n < 0 or n > Sys.max_string_length .
78 val empty : bytes
82 A byte sequence of size 0.
84 val copy : bytes -> bytes
88 Return a new byte sequence that contains the same bytes as the argu‐
90 ment.
91 val of_string : string -> bytes
95 Return a new byte sequence that contains the same bytes as the given
97 string.
98 val to_string : bytes -> string
102 Return a new string that contains the same bytes as the given byte
104 sequence.
105 val sub : bytes -> pos:int -> len:int -> bytes
109 sub s start len returns a new byte sequence of length len , containing
112 the subsequence of s that starts at position start and has length len .
113 Raises Invalid_argument if start and len do not designate a valid range
116 of s .
117 val sub_string : bytes -> pos:int -> len:int -> string
121 Same as sub but return a string instead of a byte sequence.
123 val extend : bytes -> left:int -> right:int -> bytes
127 extend s left right returns a new byte sequence that contains the bytes
130 of s , with left uninitialized bytes prepended and right uninitialized
131 bytes appended to it. If left or right is negative, then bytes are
132 removed (instead of appended) from the corresponding side of s .
133 Since 4.05.0
136 Raises Invalid_argument if the result length is negative or longer than
139 Sys.max_string_length bytes.
140 val fill : bytes -> pos:int -> len:int -> char -> unit
144 fill s start len c modifies s in place, replacing len characters with c
147 , starting at start .
148 Raises Invalid_argument if start and len do not designate a valid range
151 of s .
152 val blit : src:bytes -> src_pos:int -> dst:bytes -> dst_pos:int ->
156 len:int -> unit
157 blit src srcoff dst dstoff len copies len bytes from sequence src ,
160 starting at index srcoff , to sequence dst , starting at index dstoff .
161 It works correctly even if src and dst are the same byte sequence, and
162 the source and destination intervals overlap.
163 Raises Invalid_argument if srcoff and len do not designate a valid
166 range of src , or if dstoff and len do not designate a valid range of
167 dst .
168 val blit_string : src:string -> src_pos:int -> dst:bytes -> dst_pos:int
172 -> len:int -> unit
173 blit src srcoff dst dstoff len copies len bytes from string src ,
176 starting at index srcoff , to byte sequence dst , starting at index
177 dstoff .
178 Since 4.05.0
181 Raises Invalid_argument if srcoff and len do not designate a valid
184 range of src , or if dstoff and len do not designate a valid range of
185 dst .
186 val concat : sep:bytes -> bytes list -> bytes
190 concat sep sl concatenates the list of byte sequences sl , inserting
193 the separator byte sequence sep between each, and returns the result as
194 a new byte sequence.
195 val cat : bytes -> bytes -> bytes
199 cat s1 s2 concatenates s1 and s2 and returns the result as new byte
202 sequence.
203 Since 4.05.0
206 Raises Invalid_argument if the result is longer than
209 Sys.max_string_length bytes.
210 val iter : f:(char -> unit) -> bytes -> unit
214 iter f s applies function f in turn to all the bytes of s . It is
217 equivalent to f (get s 0); f (get s 1); ...; f (get s
218 (length s - 1)); () .
219 val iteri : f:(int -> char -> unit) -> bytes -> unit
223 Same as Bytes.iter , but the function is applied to the index of the
225 byte as first argument and the byte itself as second argument.
226 val map : f:(char -> char) -> bytes -> bytes
230 map f s applies function f in turn to all the bytes of s and stores the
233 resulting bytes in a new sequence that is returned as the result.
234 val mapi : f:(int -> char -> char) -> bytes -> bytes
238 mapi f s calls f with each character of s and its index (in increasing
241 index order) and stores the resulting bytes in a new sequence that is
242 returned as the result.
243 val trim : bytes -> bytes
247 Return a copy of the argument, without leading and trailing whitespace.
249 The bytes regarded as whitespace are the ASCII characters ' ' , '\012'
250 , '\n' , '\r' , and '\t' .
251 val escaped : bytes -> bytes
255 Return a copy of the argument, with special characters represented by
257 escape sequences, following the lexical conventions of OCaml.
258 val index : bytes -> char -> int
262 index s c returns the index of the first occurrence of byte c in s .
265 Raises Not_found if c does not occur in s .
268 val index_opt : bytes -> char -> int option
272 index_opt s c returns the index of the first occurrence of byte c in s
275 or None if c does not occur in s .
276 Since 4.05
279 val rindex : bytes -> char -> int
283 rindex s c returns the index of the last occurrence of byte c in s .
286 Raises Not_found if c does not occur in s .
289 val rindex_opt : bytes -> char -> int option
293 rindex_opt s c returns the index of the last occurrence of byte c in s
296 or None if c does not occur in s .
297 Since 4.05
300 val index_from : bytes -> int -> char -> int
304 index_from s i c returns the index of the first occurrence of byte c in
307 s after position i . Bytes.index s c is equivalent to Bytes.index_from
308 s 0 c .
309 Raises Invalid_argument if i is not a valid position in s .
312 Raises Not_found if c does not occur in s after position i .
315 val index_from_opt : bytes -> int -> char -> int option
319 index_from _opts i c returns the index of the first occurrence of byte
322 c in s after position i or None if c does not occur in s after position
323 i . Bytes.index_opt s c is equivalent to Bytes.index_from_opt s 0 c .
324 Since 4.05
327 Raises Invalid_argument if i is not a valid position in s .
330 val rindex_from : bytes -> int -> char -> int
334 rindex_from s i c returns the index of the last occurrence of byte c in
337 s before position i+1 . rindex s c is equivalent to rindex_from s
338 (Bytes.length s - 1) c .
339 Raises Invalid_argument if i+1 is not a valid position in s .
342 Raises Not_found if c does not occur in s before position i+1 .
345 val rindex_from_opt : bytes -> int -> char -> int option
349 rindex_from_opt s i c returns the index of the last occurrence of byte
352 c in s before position i+1 or None if c does not occur in s before
353 position i+1 . rindex_opt s c is equivalent to rindex_from s
354 (Bytes.length s - 1) c .
355 Since 4.05
358 Raises Invalid_argument if i+1 is not a valid position in s .
361 val contains : bytes -> char -> bool
365 contains s c tests if byte c appears in s .
368 val contains_from : bytes -> int -> char -> bool
372 contains_from s start c tests if byte c appears in s after position
375 start . contains s c is equivalent to contains_from
376 s 0 c .
377 Raises Invalid_argument if start is not a valid position in s .
380 val rcontains_from : bytes -> int -> char -> bool
384 rcontains_from s stop c tests if byte c appears in s before position
387 stop+1 .
388 Raises Invalid_argument if stop < 0 or stop+1 is not a valid position
391 in s .
392 val uppercase : bytes -> bytes
396 Deprecated. Functions operating on Latin-1 character set are depre‐
398 cated.
399 Return a copy of the argument, with all lowercase letters translated to
402 uppercase, including accented letters of the ISO Latin-1 (8859-1) char‐
403 acter set.
404 val lowercase : bytes -> bytes
408 Deprecated. Functions operating on Latin-1 character set are depre‐
410 cated.
411 Return a copy of the argument, with all uppercase letters translated to
414 lowercase, including accented letters of the ISO Latin-1 (8859-1) char‐
415 acter set.
416 val capitalize : bytes -> bytes
420 Deprecated. Functions operating on Latin-1 character set are depre‐
422 cated.
423 Return a copy of the argument, with the first character set to upper‐
426 case, using the ISO Latin-1 (8859-1) character set..
427 val uncapitalize : bytes -> bytes
431 Deprecated. Functions operating on Latin-1 character set are depre‐
433 cated.
434 Return a copy of the argument, with the first character set to lower‐
437 case, using the ISO Latin-1 (8859-1) character set..
438 val uppercase_ascii : bytes -> bytes
442 Return a copy of the argument, with all lowercase letters translated to
444 uppercase, using the US-ASCII character set.
445 Since 4.05.0
448 val lowercase_ascii : bytes -> bytes
452 Return a copy of the argument, with all uppercase letters translated to
454 lowercase, using the US-ASCII character set.
455 Since 4.05.0
458 val capitalize_ascii : bytes -> bytes
462 Return a copy of the argument, with the first character set to upper‐
464 case, using the US-ASCII character set.
465 Since 4.05.0
468 val uncapitalize_ascii : bytes -> bytes
472 Return a copy of the argument, with the first character set to lower‐
474 case, using the US-ASCII character set.
475 Since 4.05.0
478 type t = bytes
481 An alias for the type of byte sequences.
484 val compare : t -> t -> int
488 The comparison function for byte sequences, with the same specification
490 as compare . Along with the type t , this function compare allows the
491 module Bytes to be passed as argument to the functors Set.Make and
492 Map.Make .
493 val equal : t -> t -> bool
497 The equality function for byte sequences.
499 Since 4.05.0
502 Iterators
507 val to_seq : t -> char Seq.t
508 Iterate on the string, in increasing index order. Modifications of the
510 string during iteration will be reflected in the iterator.
511 Since 4.07
514 val to_seqi : t -> (int * char) Seq.t
518 Iterate on the string, in increasing order, yielding indices along
520 chars
521 Since 4.07
524 val of_seq : char Seq.t -> t
528 Create a string from the generator
530 Since 4.07
533 Binary encoding/decoding of integers
538 The functions in this section binary encode and decode integers to and
539 from byte sequences.
540 All following functions raise Invalid_argument if the space needed at
542 index i to decode or encode the integer is not available.
543 Little-endian (resp. big-endian) encoding means that least (resp. most)
545 significant bytes are stored first. Big-endian is also known as net‐
546 work byte order. Native-endian encoding is either little-endian or
547 big-endian depending on Sys.big_endian .
548 32-bit and 64-bit integers are represented by the int32 and int64
550 types, which can be interpreted either as signed or unsigned numbers.
551 8-bit and 16-bit integers are represented by the int type, which has
553 more bits than the binary encoding. These extra bits are handled as
554 follows:
555 -Functions that decode signed (resp. unsigned) 8-bit or 16-bit integers
557 represented by int values sign-extend (resp. zero-extend) their result.
558 -Functions that encode 8-bit or 16-bit integers represented by int val‐
560 ues truncate their input to their least significant bytes.
561 val get_uint8 : bytes -> int -> int
564 get_uint8 b i is b 's unsigned 8-bit integer starting at byte index i .
567 Since 4.08
570 val get_int8 : bytes -> int -> int
574 get_int8 b i is b 's signed 8-bit integer starting at byte index i .
577 Since 4.08
580 val get_uint16_ne : bytes -> int -> int
584 get_uint16_ne b i is b 's native-endian unsigned 16-bit integer start‐
587 ing at byte index i .
588 Since 4.08
591 val get_uint16_be : bytes -> int -> int
595 get_uint16_be b i is b 's big-endian unsigned 16-bit integer starting
598 at byte index i .
599 Since 4.08
602 val get_uint16_le : bytes -> int -> int
606 get_uint16_le b i is b 's little-endian unsigned 16-bit integer start‐
609 ing at byte index i .
610 Since 4.08
613 val get_int16_ne : bytes -> int -> int
617 get_int16_ne b i is b 's native-endian signed 16-bit integer starting
620 at byte index i .
621 Since 4.08
624 val get_int16_be : bytes -> int -> int
628 get_int16_be b i is b 's big-endian signed 16-bit integer starting at
631 byte index i .
632 Since 4.08
635 val get_int16_le : bytes -> int -> int
639 get_int16_le b i is b 's little-endian signed 16-bit integer starting
642 at byte index i .
643 Since 4.08
646 val get_int32_ne : bytes -> int -> int32
650 get_int32_ne b i is b 's native-endian 32-bit integer starting at byte
653 index i .
654 Since 4.08
657 val get_int32_be : bytes -> int -> int32
661 get_int32_be b i is b 's big-endian 32-bit integer starting at byte
664 index i .
665 Since 4.08
668 val get_int32_le : bytes -> int -> int32
672 get_int32_le b i is b 's little-endian 32-bit integer starting at byte
675 index i .
676 Since 4.08
679 val get_int64_ne : bytes -> int -> int64
683 get_int64_ne b i is b 's native-endian 64-bit integer starting at byte
686 index i .
687 Since 4.08
690 val get_int64_be : bytes -> int -> int64
694 get_int64_be b i is b 's big-endian 64-bit integer starting at byte
697 index i .
698 Since 4.08
701 val get_int64_le : bytes -> int -> int64
705 get_int64_le b i is b 's little-endian 64-bit integer starting at byte
708 index i .
709 Since 4.08
712 val set_uint8 : bytes -> int -> int -> unit
716 set_uint8 b i v sets b 's unsigned 8-bit integer starting at byte index
719 i to v .
720 Since 4.08
723 val set_int8 : bytes -> int -> int -> unit
727 set_int8 b i v sets b 's signed 8-bit integer starting at byte index i
730 to v .
731 Since 4.08
734 val set_uint16_ne : bytes -> int -> int -> unit
738 set_uint16_ne b i v sets b 's native-endian unsigned 16-bit integer
741 starting at byte index i to v .
742 Since 4.08
745 val set_uint16_be : bytes -> int -> int -> unit
749 set_uint16_be b i v sets b 's big-endian unsigned 16-bit integer start‐
752 ing at byte index i to v .
753 Since 4.08
756 val set_uint16_le : bytes -> int -> int -> unit
760 set_uint16_le b i v sets b 's little-endian unsigned 16-bit integer
763 starting at byte index i to v .
764 Since 4.08
767 val set_int16_ne : bytes -> int -> int -> unit
771 set_int16_ne b i v sets b 's native-endian signed 16-bit integer start‐
774 ing at byte index i to v .
775 Since 4.08
778 val set_int16_be : bytes -> int -> int -> unit
782 set_int16_be b i v sets b 's big-endian signed 16-bit integer starting
785 at byte index i to v .
786 Since 4.08
789 val set_int16_le : bytes -> int -> int -> unit
793 set_int16_le b i v sets b 's little-endian signed 16-bit integer start‐
796 ing at byte index i to v .
797 Since 4.08
800 val set_int32_ne : bytes -> int -> int32 -> unit
804 set_int32_ne b i v sets b 's native-endian 32-bit integer starting at
807 byte index i to v .
808 Since 4.08
811 val set_int32_be : bytes -> int -> int32 -> unit
815 set_int32_be b i v sets b 's big-endian 32-bit integer starting at byte
818 index i to v .
819 Since 4.08
822 val set_int32_le : bytes -> int -> int32 -> unit
826 set_int32_le b i v sets b 's little-endian 32-bit integer starting at
829 byte index i to v .
830 Since 4.08
833 val set_int64_ne : bytes -> int -> int64 -> unit
837 set_int64_ne b i v sets b 's native-endian 64-bit integer starting at
840 byte index i to v .
841 Since 4.08
844 val set_int64_be : bytes -> int -> int64 -> unit
848 set_int64_be b i v sets b 's big-endian 64-bit integer starting at byte
851 index i to v .
852 Since 4.08
855 val set_int64_le : bytes -> int -> int64 -> unit
859 set_int64_le b i v sets b 's little-endian 64-bit integer starting at
862 byte index i to v .
863 Since 4.08
866OCamldoc 2020-09-01 Stdlib.BytesLabels(3)