package batteries

You can search for identifiers within the package.

in-package search v0.2.0

A community-maintained standard library extension

Install

dune-project

Dependency

batteries.forge.ocamlcore.org Edit opam file Versions (15)

Authors

O

OCaml batteries-included team

Maintainers

Sources

v3.2.0.tar.gz

sha256=00f34b9aed4e47f314425b2ca9ceac206f112095a17ea9a7ffa6dac8cfccc492

md5=066051f9a210277710c54ad57c3b9568

doc/batteries.unthreaded/BatBase64/index.html

Module `BatBase64`

Base64 codec.

8-bit characters are encoded into 6-bit ones using ASCII lookup tables. Default tables maps 0..63 values on characters A-Z, a-z, 0-9, '+' and '/' (in that order).

@documents Base64

author Nicolas Cannasse

exception Invalid_char

This exception is raised when reading an invalid character from a base64 input.

exception Invalid_table

This exception is raised if the encoding or decoding table size is not correct.

type encoding_table = char array

An encoding table maps integers 0..63 to the corresponding char.

type decoding_table = int array

A decoding table maps chars 0..255 to the corresponding 0..63 value or -1 if the char is not accepted.

val str_encode : ?tbl:encoding_table -> string -> string

Encode a string into Base64.

val str_decode : ?tbl:decoding_table -> string -> string

Decode a string encoded into Base64, raise Invalid_char if a character in the input string is not a valid one.

val encode : ?tbl:encoding_table -> 'a BatIO.output -> 'a BatIO.output

Generic base64 encoding over an output.

val decode : ?tbl:decoding_table -> BatIO.input -> BatIO.input

Generic base64 decoding over an input.

val make_decoding_table : encoding_table -> decoding_table

Create a valid decoding table from an encoding one.