diff options
Diffstat (limited to 'sid.mli')
| -rw-r--r-- | sid.mli | 12 |
1 files changed, 12 insertions, 0 deletions
@@ -40,12 +40,24 @@ module StringFmt : module PacketRep : sig type endian = Big | Little + (** Specify the endianness when internalizing integers. Only relevant for + subauthorities as the identifier authority is specified as big endian. + The default is always [Little]. *) + val decode : ?endian:endian -> bytes -> (t, string) result (** [decode endian b] decode the byte buffer [b] as a SID. *) val encode : ?endian:endian -> t -> bytes (** [encode endian s] convert SID [s] to the packet representation encoding subauthorities in endianness [endian]. *) + + val from_channel : ?endian:endian -> in_channel -> (t, string) result + (** [from_channel endian ic] read binary SID from [ic] with endianness + [endian]. *) + + val to_channel : ?endian:endian -> out_channel -> t -> unit + (** [to_channel endian oc s] write SID [s] in packet representation + to channel [oc] with endianness [endian]. *) end (** Pre-defined SID constansts and constructors with fixed identifier |