Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

base64 (3erl)

Name

base64 - Provides base64 encode and decode, see RFC 2045.

Synopsis

Please see following description for synopsis

Description

base64(3)                  Erlang Module Definition                  base64(3)



NAME
       base64 - Provides base64 encode and decode, see
           RFC 2045.

DESCRIPTION
       Provides base64 encode and decode, see RFC 2045.

DATA TYPES
       base64_alphabet() = 65..90 | 97..122 | 48..57 | 43 | 47 | 61

              Base 64 Encoding alphabet, see RFC 4648.

       base64_string() = [base64_alphabet()]

              Base 64 encoded string.

       base64_binary() = binary()

              Base 64 encoded binary.

       byte_string() = [byte()]

              Arbitrary sequences of octets.

EXPORTS
       decode(Base64) -> Data

       decode_to_string(Base64) -> DataString

       mime_decode(Base64) -> Data

       mime_decode_to_string(Base64) -> DataString

              Types:

                 Base64 = base64_string() | base64_binary()
                 Data = binary()
                 DataString = byte_string()

              Decodes a base64-encoded string to plain ASCII. See RFC 4648.

              mime_decode/1  and  mime_decode_to_string/1  strip  away illegal
              characters, while decode/1  and  decode_to_string/1  only  strip
              away whitespace characters.

       encode(Data) -> Base64

       encode_to_string(Data) -> Base64String

              Types:

                 Data = byte_string() | binary()
                 Base64 = base64_binary()
                 Base64String = base64_string()

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



Ericsson AB                       stdlib 3.17                        base64(3)