20072023 Ericsson AB. All Rights Reserved. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. base64 Ingela Anderton Andin 2007-02-22 base64.xml
base64 Provides base64 encode and decode, see RFC 2045.

Provides base64 encode and decode, see RFC 2045.

Base 64 Encoding alphabet, see RFC 4648.

Selector for the Base 64 Encoding alphabet used for encoding and decoding. See RFC 4648 Sections 4 and 5.

Customises the behaviour of the encode and decode functions. Default value if omitted entirely or partially is #{mode => standard, padding => true}.

Base 64 encoded string.

Base 64 encoded binary.

Arbitrary sequences of octets.

Decode a base64 encoded string to data.

Decodes a base64 string encoded using the standard alphabet according to RFC 4648 Section 4 to plain ASCII.

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.

Checks the correct number of = padding characters at the end of the encoded string.

Decode a base64 encoded string to data.

Decodes a base64 string encoded using the alphabet indicated by the mode option to plain ASCII.

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

The mode option can be one of the following:

standard Default. Decode the given string using the standard base64 alphabet according to RFC 4648 Section 4, that is "+" and "/" are representing bytes 62 and 63 respectively, while "-" and "_" are illegal characters. urlsafe Decode the given string using the alternative "URL and Filename safe" base64 alphabet according to RFC 4648 Section 5, that is "-" and "_" are representing bytes 62 and 63 respectively, while "+" and "/" are illegal characters.

The padding option can be one of the following:

true Default. Checks the correct number of = padding characters at the end of the encoded string. false Accepts an encoded string with missing = padding characters at the end.
Encode data into base64.

Encodes a plain ASCII string into base64 using the standard alphabet according to RFC 4648 Section 4. The result is 33% larger than the data.

Always appends correct number of = padding characters to the encoded string.

Encode data into base64.

Encodes a plain ASCII string into base64 using the alphabet indicated by the mode option. The result is 33% larger than the data.

The mode option can be one of the following:

standard Default. Encode the given string using the standard base64 alphabet according to RFC 4648 Section 4. urlsafe Encode the given string using the alternative "URL and Filename safe" base64 alphabet according to RFC 4648 Section 5.

The padding option can be one of the following:

true Default. Appends correct number of = padding characters to the encoded string. false Skips appending = padding characters to the encoded string.