Skip to content

base64: Allow options list for encode/decode functions #10472

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
juhlig wants to merge 1 commit into from
+20 −7
Closed

base64: Allow options list for encode/decode functions #10472

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 20 additions & 7 deletions lib/stdlib/src/base64.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,10 +81,11 @@ The `padding` option can be one of the following:
the end.

""".
-type decode_options() :: #{padding => boolean(), mode => base64_mode()}.
-type decode_options() :: #{padding => boolean(), mode => base64_mode()}
| [{padding, boolean()} | {mode, base64_mode()}].

-doc """
Customizes the behaviour of the decode functions.
Customizes the behaviour of the encode functions.

Default value if omitted entirely or partially is `#{mode => standard, padding => true}`.

Expand All @@ -106,7 +107,8 @@ The `padding` option can be one of the following:
- **`false`** - Skips appending `=` padding characters to the encoded string.

""".
-type encode_options() :: #{padding => boolean(), mode => base64_mode()}.
-type encode_options() :: #{padding => boolean(), mode => base64_mode()}
| [{padding, boolean()} | {mode, base64_mode()}].

%% The following type is a subtype of string() for return values
%% of encoding functions.
Expand Down Expand Up @@ -274,7 +276,7 @@ Decodes a base64 string encoded using the standard alphabet according to
[RFC 4648 Section 4](https://datatracker.ietf.org/doc/html/rfc4648#section-4) to
plain ASCII.

The function will strips away any whitespace characters and check for the
The function will strip away any whitespace characters and check for the
the correct number of `=` padding characters at the end of the encoded string.

See `t:decode_options/0` for details on which options can be passed.
Expand Down Expand Up @@ -317,7 +319,7 @@ Decodes a base64 "mime" string encoded using the standard alphabet according to
[RFC 4648 Section 4](https://datatracker.ietf.org/doc/html/rfc4648#section-4) to
plain ASCII.

The function will strips away any illegal characters. It does *not* check for the
The function will strip away any illegal characters. It does *not* check for the
the correct number of `=` padding characters at the end of the encoded string.

See `t:decode_options/0` for details on which options can be passed.
Expand Down Expand Up @@ -781,11 +783,22 @@ format_error(_, _) ->
%% accessors

get_padding(#{padding := Bool}) when is_boolean(Bool) -> Bool;
get_padding(#{}) -> true.
get_padding(#{}) -> true;
get_padding(Opts) when is_list(Opts) ->
case lists:keyfind(padding, 1, Opts) of
{padding, Bool} when is_boolean(Bool) -> Bool;
_ -> true
end.

get_decoding_offset(#{mode := standard}) -> 1;
get_decoding_offset(#{mode := urlsafe}) -> 257;
get_decoding_offset(#{}) -> 1.
get_decoding_offset(#{}) -> 1;
get_decoding_offset(Opts) when is_list(Opts) ->
case lists:keyfind(mode, Opts) of
{mode, standard} -> 1;
{mode, urlsafe} -> 257;
_ -> 1
end.

-compile({inline, [{b64d, 2}]}).
b64d(X, Off) ->
Expand Down
Loading