blob: 32dee4c9c54906e9cc125e67abb071bc0fe875a8 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
(************************************************************************)
(* ocplib-endian *)
(* *)
(* Copyright 2012 OCamlPro *)
(* *)
(* This file is distributed under the terms of the GNU Lesser General *)
(* Public License as published by the Free Software Foundation; either *)
(* version 2.1 of the License, or (at your option) any later version, *)
(* with the OCaml static compilation exception. *)
(* *)
(* ocplib-endian is distributed in the hope that it will be useful, *)
(* but WITHOUT ANY WARRANTY; without even the implied warranty of *)
(* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *)
(* GNU General Public License for more details. *)
(* *)
(************************************************************************)
module type EndianStringSig = sig
(** Functions reading according to Big Endian byte order *)
val get_char : string -> int -> char
(** [get_char buff i] reads 1 byte at offset i as a char *)
val get_uint8 : string -> int -> int
(** [get_uint8 buff i] reads 1 byte at offset i as an unsigned int of 8
bits. i.e. It returns a value between 0 and 2^8-1 *)
val get_int8 : string -> int -> int
(** [get_int8 buff i] reads 1 byte at offset i as a signed int of 8
bits. i.e. It returns a value between -2^7 and 2^7-1 *)
val get_uint16 : string -> int -> int
(** [get_uint16 buff i] reads 2 bytes at offset i as an unsigned int
of 16 bits. i.e. It returns a value between 0 and 2^16-1 *)
val get_int16 : string -> int -> int
(** [get_int16 buff i] reads 2 byte at offset i as a signed int of
16 bits. i.e. It returns a value between -2^15 and 2^15-1 *)
val get_int32 : string -> int -> int32
(** [get_int32 buff i] reads 4 bytes at offset i as an int32. *)
val get_int64 : string -> int -> int64
(** [get_int64 buff i] reads 8 bytes at offset i as an int64. *)
val get_float : string -> int -> float
(** [get_float buff i] is equivalent to
[Int32.float_of_bits (get_int32 buff i)] *)
val get_double : string -> int -> float
(** [get_double buff i] is equivalent to
[Int64.float_of_bits (get_int64 buff i)] *)
val set_char : Bytes.t -> int -> char -> unit
[@@ocaml.deprecated "Use EndianBytes.set_char instead."]
(** @deprecated This is a deprecated alias of {!endianBytes.set_char}. *)
val set_int8 : Bytes.t -> int -> int -> unit
[@@ocaml.deprecated "Use EndianBytes.set_int8 instead."]
(** @deprecated This is a deprecated alias of {!endianBytes.set_int8}. *)
val set_int16 : Bytes.t -> int -> int -> unit
[@@ocaml.deprecated "Use EndianBytes.set_int16 instead."]
(** @deprecated This is a deprecated alias of {!endianBytes.set_int16}. *)
val set_int32 : Bytes.t -> int -> int32 -> unit
[@@ocaml.deprecated "Use EndianBytes.set_int13 instead."]
(** @deprecated This is a deprecated alias of {!endianBytes.set_int32}. *)
val set_int64 : Bytes.t -> int -> int64 -> unit
[@@ocaml.deprecated "Use EndianBytes.set_int64 instead."]
(** @deprecated This is a deprecated alias of {!endianBytes.set_int64}. *)
val set_float : Bytes.t -> int -> float -> unit
[@@ocaml.deprecated "Use EndianBytes.set_float instead."]
(** @deprecated This is a deprecated alias of {!endianBytes.set_float}. *)
val set_double : Bytes.t -> int -> float -> unit
[@@ocaml.deprecated "Use EndianBytes.set_double instead."]
(** @deprecated This is a deprecated alias of {!endianBytes.set_double}. *)
end
module BigEndian : sig
(** Functions reading according to Big Endian byte order without
checking for overflow *)
include EndianStringSig
end
module BigEndian_unsafe : sig
(** Functions reading according to Big Endian byte order without
checking for overflow *)
include EndianStringSig
end
module LittleEndian : sig
(** Functions reading according to Little Endian byte order *)
include EndianStringSig
end
module LittleEndian_unsafe : sig
(** Functions reading according to Big Endian byte order without
checking for overflow *)
include EndianStringSig
end
module NativeEndian : sig
(** Functions reading according to machine endianness *)
include EndianStringSig
end
module NativeEndian_unsafe : sig
(** Functions reading according to machine endianness without
checking for overflow *)
include EndianStringSig
end
|
