[#BloombergLP-bdlde-Base64EncoderOptions]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlde.adoc[bdlde]::Base64EncoderOptions
:relfileprefix: ../../
:mrdocs:

This `class` stores the configuration of a `Base64Encoder`.

== Synopsis

Declared in `<bdlde_base64encoderoptions.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class Base64EncoderOptions;
----

== Enums

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlde/Base64EncoderOptions/_04enum.adoc[`Unnamed enum`] 
| MIME Base64 encoding constants.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlde/Base64EncoderOptions/alphabet.adoc[`alphabet`] 
| Return the value of the `alphabet` attribute.
| xref:BloombergLP/bdlde/Base64EncoderOptions/isPadded.adoc[`isPadded`] 
| Return the value of the `isPadded` attribute.
| xref:BloombergLP/bdlde/Base64EncoderOptions/maxLineLength.adoc[`maxLineLength`] 
| Return the value of the `maxLineLength` attribute.
| xref:BloombergLP/bdlde/Base64EncoderOptions/print.adoc[`print`] 
| Format this object to the specified output `stream` at the optionally specified indentation `level` and return a reference to the modifiable `stream`. If `level` is specified, optionally specify `spacesPerLevel`, the number of spaces per indentation level for this and all of its nested objects. Each line is indented by the absolute value of `level * spacesPerLevel`. If `level` is negative, suppress indentation of the first line. If `spacesPerLevel` is negative, suppress line breaks and format the entire output on one line. If `stream` is initially invalid, this operation has no effect. Note that a trailing newline is provided in multiline mode only.
| xref:BloombergLP/bdlde/Base64EncoderOptions/setAlphabet.adoc[`setAlphabet`] 
| Set the `alphabet` attribute to the specified `value`. The behavior is undefined unless `value` is either `e_BASIC` or `e_UTL`.
| xref:BloombergLP/bdlde/Base64EncoderOptions/setIsPadded.adoc[`setIsPadded`] 
| Set the `isPadded` attribute to the specified `value`.
| xref:BloombergLP/bdlde/Base64EncoderOptions/setMaxLineLength.adoc[`setMaxLineLength`] 
| Set the `maxLineLength` attribute to the specified `value`. The behavior is undefined unless `0 <= value`.
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlde/Base64EncoderOptions/custom.adoc[`custom`] 
| Return a `Base64EncoderOptions` object having the specified `maxLineLength, alphabet, and `isPadded' attribute values. The behavior is unless `0 <= maxLineLength` and 'alphabet is a defined value of `Base64Alphabet::Enum`.
| xref:BloombergLP/bdlde/Base64EncoderOptions/mime.adoc[`mime`] 
| Return a `Base64EncoderOptions` object having the attributes `maxLineLength == 76`, `alphabet == Base64Alphabet::e_BASIC`, and `isPadded == true`. This conforms to RFC 2045.
| xref:BloombergLP/bdlde/Base64EncoderOptions/standard.adoc[`standard`] 
| Return a `Base64EncoderOptions` object having the attributes `maxLineLength == 0`, `alphabet == Base64Alphabet::e_BASIC`, and `isPadded == false`. If `padded` is not specified, it defaults to `true`. This conforms to RFC 4648 section 4.
| xref:BloombergLP/bdlde/Base64EncoderOptions/urlSafe.adoc[`urlSafe`] 
| Return a `Base64EncoderOptions` object having the attributes `maxLineLength == 0`, `alphabet == Base64Alphabet::e_URL`, and the specified `padded`. If `padded` is not specified, it defaults to `false`. This conforms to RFC 4648 section 5.
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlde/operator_not_eq-0a.adoc[`operator!=`]
| Return `true` if the specified `lhs` and `rhs` attribute objects do not have the same value, and `false` otherwise. Two attribute objects do not have the same value if one or more respective attributes differ in values.
| xref:BloombergLP/bdlde/operator_eq-0d.adoc[`operator==`]
| Return `true` if the specified `lhs` and `rhs` attribute objects have the same value, and `false` otherwise. Two attribute objects have the same value if each respective attribute has the same value.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#