Module `Base32`Source

Base32 RFC4648 implementation.

Base32 is a group of similar binary-to-text encoding schemes that represent binary data in an ASCII string format by translating it into a radix-32 representation. It is specified in RFC 4648.

Release %%VERSION%% - %%PKG_HOMEPAGE%%

Sourcetype alphabet

Type of alphabet.

Sourcetype sub = string * int * int

Type of sub-string: str, off, len.

Sourceval default_alphabet : alphabet

A 32-character alphabet specifying the regular Base32 alphabet.

Sourceval make_alphabet : string -> alphabet

Make a new alphabet.

Sourceval length_alphabet : alphabet -> int

Returns length of the alphabet, should be 64.

Sourceval alphabet : alphabet -> int array

Returns the alphabet.

Sourceval decode_exn : ?alphabet:alphabet -> ?off:int -> ?len:int -> string -> string

decode_exn ?off ?len s decodes len bytes (defaults to String.length s - off) of the string s starting from off (defaults to 0) that is encoded in Base32 format. Will leave trailing NULLs on the string, padding it out to a multiple of 3 characters. alphabet defaults to default_alphabet. pad = true specifies to check if s is padded or not, otherwise, it raises an exception.

Decoder can fail when character of s is not a part of alphabet or is not padding character. If input is not padded correctly, decoder does the best-effort but it does not ensure decode_exn (encode ~pad:false x) = x.

raises if
Invalid_argument s is not a valid Base32 string.

Source

val decode_sub : 
  ?alphabet:alphabet ->
  ?off:int ->
  ?len:int ->
  string ->
  (sub, [> `Msg of string ]) result

Same as decode_exn but it returns a result type instead to raise an exception. Then, it returns a sub string. Decoded input (str, off, len) will starting to off and will have len bytes - by this way, we ensure to allocate only one time result.

Source

val decode : 
  ?alphabet:alphabet ->
  ?off:int ->
  ?len:int ->
  string ->
  (string, [> `Msg of string ]) result

Same as decode_exn, but returns an explicit error message result if it fails.

Source

val encode : 
  ?pad:bool ->
  ?alphabet:alphabet ->
  ?off:int ->
  ?len:int ->
  string ->
  (string, [> `Msg of string ]) result

encode s encodes the string s into base32. If pad is false, no trailing padding is added. pad defaults to true, and alphabet to default_alphabet.

encode fails when off and len do not designate a valid range of s.

Sourceval encode_string : ?pad:bool -> ?alphabet:alphabet -> string -> string

encode_string s encodes the string s into base32. If pad is false, no trailing padding is added. pad defaults to true, and alphabet to default_alphabet.

Source

val encode_sub : 
  ?pad:bool ->
  ?alphabet:alphabet ->
  ?off:int ->
  ?len:int ->
  string ->
  (sub, [> `Msg of string ]) result

Same as encode but return a sub-string instead a plain result. By this way, we ensure to allocate only one time result.

Source

val encode_exn : 
  ?pad:bool ->
  ?alphabet:alphabet ->
  ?off:int ->
  ?len:int ->
  string ->
  string

Same as encode but raises an invalid argument exception if we retrieve an error.

package base32

Module Base32Source

Module `Base32`Source