This class stores the configuration of a Base64Encoder.

Synopsis

Declared in <bdlde_base64encoderoptions.h>

class Base64EncoderOptions;

Enums

Name

Description

Unnamed enum

MIME Base64 encoding constants.

Member Functions

Name

Description

alphabet

Return the value of the alphabet attribute.

isPadded

Return the value of the isPadded attribute.

maxLineLength

Return the value of the maxLineLength attribute.

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.

setAlphabet

Set the alphabet attribute to the specified value. The behavior is undefined unless value is either e_BASIC or e_UTL.

setIsPadded

Set the isPadded attribute to the specified value.

setMaxLineLength

Set the maxLineLength attribute to the specified value. The behavior is undefined unless 0 <= value.

Static Member Functions

Name

Description

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.

mime

Return a Base64EncoderOptions object having the attributes maxLineLength == 76, alphabet == Base64Alphabet::e_BASIC, and isPadded == true. This conforms to RFC 2045.

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.

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

Name

Description

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.

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.

Created with MrDocs