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 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 -> pos:int -> len: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 compare . Along with the type t , this function compare allows the
465 module Bytes to be passed as argument to the functors Set.Make and
466 Map.Make .
467 val equal : t -> t -> bool
471 The equality function for byte sequences.
473 Since 4.05.0
476 Iterators
481 val to_seq : t -> char Seq.t
482 Iterate on the string, in increasing index order. Modifications of the
484 string during iteration will be reflected in the iterator.
485 Since 4.07
488 val to_seqi : t -> (int * char) Seq.t
492 Iterate on the string, in increasing order, yielding indices along
494 chars
495 Since 4.07
498 val of_seq : char Seq.t -> t
502 Create a string from the generator
504 Since 4.07
507 Binary encoding/decoding of integers
512 The functions in this section binary encode and decode integers to and
513 from byte sequences.
514 All following functions raise Invalid_argument if the space needed at
516 index i to decode or encode the integer is not available.
517 Little-endian (resp. big-endian) encoding means that least (resp. most)
519 significant bytes are stored first. Big-endian is also known as net‐
520 work byte order. Native-endian encoding is either little-endian or
521 big-endian depending on Sys.big_endian .
522 32-bit and 64-bit integers are represented by the int32 and int64
524 types, which can be interpreted either as signed or unsigned numbers.
525 8-bit and 16-bit integers are represented by the int type, which has
527 more bits than the binary encoding. These extra bits are handled as
528 follows:
529 -Functions that decode signed (resp. unsigned) 8-bit or 16-bit integers
531 represented by int values sign-extend (resp. zero-extend) their result.
532 -Functions that encode 8-bit or 16-bit integers represented by int val‐
534 ues truncate their input to their least significant bytes.
535 val get_uint8 : bytes -> int -> int
538 get_uint8 b i is b 's unsigned 8-bit integer starting at byte index i .
541 Since 4.08
544 val get_int8 : bytes -> int -> int
548 get_int8 b i is b 's signed 8-bit integer starting at byte index i .
551 Since 4.08
554 val get_uint16_ne : bytes -> int -> int
558 get_uint16_ne b i is b 's native-endian unsigned 16-bit integer start‐
561 ing at byte index i .
562 Since 4.08
565 val get_uint16_be : bytes -> int -> int
569 get_uint16_be b i is b 's big-endian unsigned 16-bit integer starting
572 at byte index i .
573 Since 4.08
576 val get_uint16_le : bytes -> int -> int
580 get_uint16_le b i is b 's little-endian unsigned 16-bit integer start‐
583 ing at byte index i .
584 Since 4.08
587 val get_int16_ne : bytes -> int -> int
591 get_int16_ne b i is b 's native-endian signed 16-bit integer starting
594 at byte index i .
595 Since 4.08
598 val get_int16_be : bytes -> int -> int
602 get_int16_be b i is b 's big-endian signed 16-bit integer starting at
605 byte index i .
606 Since 4.08
609 val get_int16_le : bytes -> int -> int
613 get_int16_le b i is b 's little-endian signed 16-bit integer starting
616 at byte index i .
617 Since 4.08
620 val get_int32_ne : bytes -> int -> int32
624 get_int32_ne b i is b 's native-endian 32-bit integer starting at byte
627 index i .
628 Since 4.08
631 val get_int32_be : bytes -> int -> int32
635 get_int32_be b i is b 's big-endian 32-bit integer starting at byte
638 index i .
639 Since 4.08
642 val get_int32_le : bytes -> int -> int32
646 get_int32_le b i is b 's little-endian 32-bit integer starting at byte
649 index i .
650 Since 4.08
653 val get_int64_ne : bytes -> int -> int64
657 get_int64_ne b i is b 's native-endian 64-bit integer starting at byte
660 index i .
661 Since 4.08
664 val get_int64_be : bytes -> int -> int64
668 get_int64_be b i is b 's big-endian 64-bit integer starting at byte
671 index i .
672 Since 4.08
675 val get_int64_le : bytes -> int -> int64
679 get_int64_le b i is b 's little-endian 64-bit integer starting at byte
682 index i .
683 Since 4.08
686 val set_uint8 : bytes -> int -> int -> unit
690 set_uint8 b i v sets b 's unsigned 8-bit integer starting at byte index
693 i to v .
694 Since 4.08
697 val set_int8 : bytes -> int -> int -> unit
701 set_int8 b i v sets b 's signed 8-bit integer starting at byte index i
704 to v .
705 Since 4.08
708 val set_uint16_ne : bytes -> int -> int -> unit
712 set_uint16_ne b i v sets b 's native-endian unsigned 16-bit integer
715 starting at byte index i to v .
716 Since 4.08
719 val set_uint16_be : bytes -> int -> int -> unit
723 set_uint16_be b i v sets b 's big-endian unsigned 16-bit integer start‐
726 ing at byte index i to v .
727 Since 4.08
730 val set_uint16_le : bytes -> int -> int -> unit
734 set_uint16_le b i v sets b 's little-endian unsigned 16-bit integer
737 starting at byte index i to v .
738 Since 4.08
741 val set_int16_ne : bytes -> int -> int -> unit
745 set_int16_ne b i v sets b 's native-endian signed 16-bit integer start‐
748 ing at byte index i to v .
749 Since 4.08
752 val set_int16_be : bytes -> int -> int -> unit
756 set_int16_be b i v sets b 's big-endian signed 16-bit integer starting
759 at byte index i to v .
760 Since 4.08
763 val set_int16_le : bytes -> int -> int -> unit
767 set_int16_le b i v sets b 's little-endian signed 16-bit integer start‐
770 ing at byte index i to v .
771 Since 4.08
774 val set_int32_ne : bytes -> int -> int32 -> unit
778 set_int32_ne b i v sets b 's native-endian 32-bit integer starting at
781 byte index i to v .
782 Since 4.08
785 val set_int32_be : bytes -> int -> int32 -> unit
789 set_int32_be b i v sets b 's big-endian 32-bit integer starting at byte
792 index i to v .
793 Since 4.08
796 val set_int32_le : bytes -> int -> int32 -> unit
800 set_int32_le b i v sets b 's little-endian 32-bit integer starting at
803 byte index i to v .
804 Since 4.08
807 val set_int64_ne : bytes -> int -> int64 -> unit
811 set_int64_ne b i v sets b 's native-endian 64-bit integer starting at
814 byte index i to v .
815 Since 4.08
818 val set_int64_be : bytes -> int -> int64 -> unit
822 set_int64_be b i v sets b 's big-endian 64-bit integer starting at byte
825 index i to v .
826 Since 4.08
829 val set_int64_le : bytes -> int -> int64 -> unit
833 set_int64_le b i v sets b 's little-endian 64-bit integer starting at
836 byte index i to v .
837 Since 4.08
840OCamldoc 2019-07-30 Stdlib.BytesLabels(3)