User's Guide
Reference Manual
Release Notes
PDF
Top

STDLIB
Reference Manual
Version 1.19.1

Expand All
Contract All

Table of Contents

# base64

### MODULE

base64

### MODULE SUMMARY

Implements base 64 encode and decode, see RFC2045.

### DESCRIPTION

Implements base 64 encode and decode, see RFC2045.

### DATA TYPES

ascii_string() = [1..255]

ascii_binary() = binary()

A binary() with ASCII characters in the range 1 to 255.

### EXPORTS

encode(Data) -> Base64
encode_to_string(Data) -> Base64String

Types:

Data = ascii_string() | ascii_binary()
Base64 = ascii_binary()
Base64String = ascii_string()

Encodes a plain ASCII string into base64. The result will be 33% larger than the data.

decode(Base64) -> Data
decode_to_string(Base64) -> DataString
mime_decode(Base64) -> Data
mime_decode_to_string(Base64) -> DataString

Types:

Base64 = ascii_string() | ascii_binary()
Data = ascii_binary()
DataString = ascii_string()

Decodes a base64 encoded string to plain ASCII. See RFC4648. mime_decode/1 and mime_decode_to_string/1 strips away illegal characters, while decode/1 and decode_to_string/1 only strips away whitespace characters.