package base64

  1. Overview
  2. Docs
package base64
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module B64Source

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 v2.3.0 - https://github.com/mirage/ocaml-base64

Sourceval default_alphabet : string

A 64-character string specifying the regular Base64 alphabet.

Sourceval uri_safe_alphabet : string

A 64-character string specifying the URI- and filename-safe Base64 alphabet.

Sourceval decode : ?alphabet:string -> string -> string

decode s decodes the string s 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.

  • raises Not_found

    if s is not a valid Base64 string.

Sourceval decode_opt : ?alphabet:string -> string -> string option

Same as decode, but returns None instead of raising.

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

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.