package base64

  1. Overview
  2. Docs
Base64 encoding for OCaml

Install 

dune-project
 Dependency

github.com Readme Changelog ISC License Edit opam file Versions (13)

Authors

  1. T
    Thomas Gazagnaire
  2. A
    Anil Madhavapeddy
  3. C
    Calascibetta Romain
  4. P
    Peter Zotov

Maintainers

  1. M
    mirageos-devel@lists.xenproject.org

Sources

base64-3.5.2.tbz
sha256=b3f5ce301aa72c7032ef90be2332d72ff3962922c00ee2aec6bcade187a2f59b
sha512=82148a1fefec9493aaeac032c8d46b9548369d7fd90a57865e009a32c8a0eef950f0f8dbb52b74bb46880a590a0b49f2daa7ab4857233734aee8e383f5a164ec

doc/base64/Base64/index.html

Module Base64Source

Base64 RFC4648 implementation.

Base64 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-64 representation. It is specified in RFC 4648.

Release v3.5.2 - https://github.com/mirage/ocaml-base64

Sourcetype alphabet

Type of alphabet.

Sourcetype sub = string * int * int

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

Sourceval default_alphabet : alphabet

A 64-character alphabet specifying the regular Base64 alphabet.

Sourceval uri_safe_alphabet : alphabet

A 64-character alphabet specifying the URI- and filename-safe Base64 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 -> string

Returns the alphabet.

Sourceval decode_exn : ?pad:bool -> ?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 Base64 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 Base64 string.

Sourceval decode_sub : ?pad:bool -> ?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.

Sourceval decode : ?pad:bool -> ?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.

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

encode s encodes the string s into base64. 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 base64. If pad is false, no trailing padding is added. pad defaults to true, and alphabet to default_alphabet.

Sourceval 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.

Sourceval 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.