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
205 (length s - 1)); () .
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
353 s 0 c .
354 Raise Invalid_argument if start is not a valid position in s .
356 val rcontains_from : bytes -> int -> char -> bool
360 rcontains_from s stop c tests if byte c appears in s before position
363 stop+1 .
364 Raise Invalid_argument if stop < 0 or stop+1 is not a valid position in
366 s .
367 val uppercase : bytes -> bytes
371 Deprecated. Functions operating on Latin-1 character set are depre‐
373 cated.
374 Return a copy of the argument, with all lowercase letters translated to
377 uppercase, including accented letters of the ISO Latin-1 (8859-1) char‐
378 acter set.
379 val lowercase : bytes -> bytes
383 Deprecated. Functions operating on Latin-1 character set are depre‐
385 cated.
386 Return a copy of the argument, with all uppercase letters translated to
389 lowercase, including accented letters of the ISO Latin-1 (8859-1) char‐
390 acter set.
391 val capitalize : bytes -> bytes
395 Deprecated. Functions operating on Latin-1 character set are depre‐
397 cated.
398 Return a copy of the argument, with the first character set to upper‐
401 case, using the ISO Latin-1 (8859-1) character set..
402 val uncapitalize : bytes -> bytes
406 Deprecated. Functions operating on Latin-1 character set are depre‐
408 cated.
409 Return a copy of the argument, with the first character set to lower‐
412 case, using the ISO Latin-1 (8859-1) character set..
413 val uppercase_ascii : bytes -> bytes
417 Return a copy of the argument, with all lowercase letters translated to
419 uppercase, using the US-ASCII character set.
420 Since 4.05.0
423 val lowercase_ascii : bytes -> bytes
427 Return a copy of the argument, with all uppercase letters translated to
429 lowercase, using the US-ASCII character set.
430 Since 4.05.0
433 val capitalize_ascii : bytes -> bytes
437 Return a copy of the argument, with the first character set to upper‐
439 case, using the US-ASCII character set.
440 Since 4.05.0
443 val uncapitalize_ascii : bytes -> bytes
447 Return a copy of the argument, with the first character set to lower‐
449 case, using the US-ASCII character set.
450 Since 4.05.0
453 type t = bytes
456 An alias for the type of byte sequences.
459 val compare : t -> t -> int
463 The comparison function for byte sequences, with the same specification
465 as compare . Along with the type t , this function compare allows the
466 module Bytes to be passed as argument to the functors Set.Make and
467 Map.Make .
468 val equal : t -> t -> bool
472 The equality function for byte sequences.
474 Since 4.05.0
477 Iterators
482 val to_seq : t -> char Seq.t
483 Iterate on the string, in increasing index order. Modifications of the
485 string during iteration will be reflected in the iterator.
486 Since 4.07
489 val to_seqi : t -> (int * char) Seq.t
493 Iterate on the string, in increasing order, yielding indices along
495 chars
496 Since 4.07
499 val of_seq : char Seq.t -> t
503 Create a string from the generator
505 Since 4.07
508 Binary encoding/decoding of integers
513 The functions in this section binary encode and decode integers to and
514 from byte sequences.
515 All following functions raise Invalid_argument if the space needed at
517 index i to decode or encode the integer is not available.
518 Little-endian (resp. big-endian) encoding means that least (resp. most)
520 significant bytes are stored first. Big-endian is also known as net‐
521 work byte order. Native-endian encoding is either little-endian or
522 big-endian depending on Sys.big_endian .
523 32-bit and 64-bit integers are represented by the int32 and int64
525 types, which can be interpreted either as signed or unsigned numbers.
526 8-bit and 16-bit integers are represented by the int type, which has
528 more bits than the binary encoding. These extra bits are handled as
529 follows:
530 -Functions that decode signed (resp. unsigned) 8-bit or 16-bit integers
532 represented by int values sign-extend (resp. zero-extend) their result.
533 -Functions that encode 8-bit or 16-bit integers represented by int val‐
535 ues truncate their input to their least significant bytes.
536 val get_uint8 : bytes -> int -> int
539 get_uint8 b i is b 's unsigned 8-bit integer starting at byte index i .
542 Since 4.08
545 val get_int8 : bytes -> int -> int
549 get_int8 b i is b 's signed 8-bit integer starting at byte index i .
552 Since 4.08
555 val get_uint16_ne : bytes -> int -> int
559 get_uint16_ne b i is b 's native-endian unsigned 16-bit integer start‐
562 ing at byte index i .
563 Since 4.08
566 val get_uint16_be : bytes -> int -> int
570 get_uint16_be b i is b 's big-endian unsigned 16-bit integer starting
573 at byte index i .
574 Since 4.08
577 val get_uint16_le : bytes -> int -> int
581 get_uint16_le b i is b 's little-endian unsigned 16-bit integer start‐
584 ing at byte index i .
585 Since 4.08
588 val get_int16_ne : bytes -> int -> int
592 get_int16_ne b i is b 's native-endian signed 16-bit integer starting
595 at byte index i .
596 Since 4.08
599 val get_int16_be : bytes -> int -> int
603 get_int16_be b i is b 's big-endian signed 16-bit integer starting at
606 byte index i .
607 Since 4.08
610 val get_int16_le : bytes -> int -> int
614 get_int16_le b i is b 's little-endian signed 16-bit integer starting
617 at byte index i .
618 Since 4.08
621 val get_int32_ne : bytes -> int -> int32
625 get_int32_ne b i is b 's native-endian 32-bit integer starting at byte
628 index i .
629 Since 4.08
632 val get_int32_be : bytes -> int -> int32
636 get_int32_be b i is b 's big-endian 32-bit integer starting at byte
639 index i .
640 Since 4.08
643 val get_int32_le : bytes -> int -> int32
647 get_int32_le b i is b 's little-endian 32-bit integer starting at byte
650 index i .
651 Since 4.08
654 val get_int64_ne : bytes -> int -> int64
658 get_int64_ne b i is b 's native-endian 64-bit integer starting at byte
661 index i .
662 Since 4.08
665 val get_int64_be : bytes -> int -> int64
669 get_int64_be b i is b 's big-endian 64-bit integer starting at byte
672 index i .
673 Since 4.08
676 val get_int64_le : bytes -> int -> int64
680 get_int64_le b i is b 's little-endian 64-bit integer starting at byte
683 index i .
684 Since 4.08
687 val set_uint8 : bytes -> int -> int -> unit
691 set_uint8 b i v sets b 's unsigned 8-bit integer starting at byte index
694 i to v .
695 Since 4.08
698 val set_int8 : bytes -> int -> int -> unit
702 set_int8 b i v sets b 's signed 8-bit integer starting at byte index i
705 to v .
706 Since 4.08
709 val set_uint16_ne : bytes -> int -> int -> unit
713 set_uint16_ne b i v sets b 's native-endian unsigned 16-bit integer
716 starting at byte index i to v .
717 Since 4.08
720 val set_uint16_be : bytes -> int -> int -> unit
724 set_uint16_be b i v sets b 's big-endian unsigned 16-bit integer start‐
727 ing at byte index i to v .
728 Since 4.08
731 val set_uint16_le : bytes -> int -> int -> unit
735 set_uint16_le b i v sets b 's little-endian unsigned 16-bit integer
738 starting at byte index i to v .
739 Since 4.08
742 val set_int16_ne : bytes -> int -> int -> unit
746 set_int16_ne b i v sets b 's native-endian signed 16-bit integer start‐
749 ing at byte index i to v .
750 Since 4.08
753 val set_int16_be : bytes -> int -> int -> unit
757 set_int16_be b i v sets b 's big-endian signed 16-bit integer starting
760 at byte index i to v .
761 Since 4.08
764 val set_int16_le : bytes -> int -> int -> unit
768 set_int16_le b i v sets b 's little-endian signed 16-bit integer start‐
771 ing at byte index i to v .
772 Since 4.08
775 val set_int32_ne : bytes -> int -> int32 -> unit
779 set_int32_ne b i v sets b 's native-endian 32-bit integer starting at
782 byte index i to v .
783 Since 4.08
786 val set_int32_be : bytes -> int -> int32 -> unit
790 set_int32_be b i v sets b 's big-endian 32-bit integer starting at byte
793 index i to v .
794 Since 4.08
797 val set_int32_le : bytes -> int -> int32 -> unit
801 set_int32_le b i v sets b 's little-endian 32-bit integer starting at
804 byte index i to v .
805 Since 4.08
808 val set_int64_ne : bytes -> int -> int64 -> unit
812 set_int64_ne b i v sets b 's native-endian 64-bit integer starting at
815 byte index i to v .
816 Since 4.08
819 val set_int64_be : bytes -> int -> int64 -> unit
823 set_int64_be b i v sets b 's big-endian 64-bit integer starting at byte
826 index i to v .
827 Since 4.08
830 val set_int64_le : bytes -> int -> int64 -> unit
834 set_int64_le b i v sets b 's little-endian 64-bit integer starting at
837 byte index i to v .
838 Since 4.08
841OCamldoc 2020-02-27 Stdlib.BytesLabels(3)