bdlde_base64encoderoptions

Detailed Description

Outline

• Purpose
• Classes
• Description
  • Usage
    • Example 1: Basic Usage
    • Example 2:
    • Example 3:
    • Example 4:

Purpose

Provide a value-semantic attribute class for encoder options.

Classes

• bdlde::Base64EncoderOptions: options for encoder

See also

bdlde_base64decoderoptions, bdlde_base64encoder, bdlde_base64decoder, bdlde_base64alphabet

Description

This component provides a value-semantic attribute class for specifying options for bdlde::Base64Encoder.

This class supports default-generated copy construction and copy assignment, but the constructor is private. To create an object one must call one of the class methods, which will return a newly-constructed object by value. Specialized class methods are provided to create objects configured for the mime, urlSafe, and standard configurations.

Other configurations may be obtained by specifying arguments to the custom class method, or by calling the setters after the object is created.

Usage

This section illustrates intended use of this component.

Example 1: Basic Usage

Suppose we want a Base64EncoderOptions object configured for MIME encoding, meaning maxLineLength == 76, alphabet == e_BASIC, and isPadded == true.

First, it turns out that those are the default values of the attributes, so all we have to do is default construct an object, and we're done.

const bdlde::Base64EncoderOptions& mimeOptions =
                                       bdlde::Base64EncoderOptions::mime();

Then, we check the attributes:

assert(mimeOptions.maxLineLength() == 76);
assert(mimeOptions.alphabet()      == bdlde::Base64Alphabet::e_BASIC);
assert(mimeOptions.isPadded()      == true);

Now, we stream the object:

mimeOptions.print(cout);

Finally, we observe the output:

[
    maxLineLength = 76
    alphabet = BASIC
    isPadded = true
]

Example 2:

Suppose we want a Base64EncoderOptions object configured for translating URL's. That would mean a maxLineLength == 0, alphabet == e_URL, and isPadded == false.

First, the class method urlSafe returns an object configured exactly that way, so we simply call it:

const bdlde::Base64EncoderOptions& urlOptions =
                                    bdlde::Base64EncoderOptions::urlSafe();

Then, we check the attributes:

assert(urlOptions.maxLineLength() == 0);
assert(urlOptions.alphabet()      == bdlde::Base64Alphabet::e_URL);
assert(urlOptions.isPadded()      == false);

Now, we stream the object:

urlOptions.print(cout);

Finally, we observe the output:

[
    maxLineLength = 0
    alphabet = URL
    isPadded = false
]

Example 3:

Suppose we want an options object configured for standard Base64:

First, we can simply call the standard class method:

const bdlde::Base64EncoderOptions& standardOptions =
                                   bdlde::Base64EncoderOptions::standard();

Then, we check the attributes:

assert(standardOptions.maxLineLength() == 0);
assert(standardOptions.alphabet()      == bdlde::Base64Alphabet::e_BASIC);
assert(standardOptions.isPadded()      == true);

Now, we stream the object:

standardOptions.print(cout);

Finally, we observe the output:

[
    maxLineLength = 0
    alphabet = BASIC
    isPadded = true
]

Example 4:

Suppose we want a really strangely configured options object with maxLineLength == 200, alphabet == e_URL, and padding.

First, we can simply call the custom class method:

const bdlde::Base64EncoderOptions& customOptions =
          bdlde::Base64EncoderOptions::custom(200,
                                              bdlde::Base64Alphabet::e_URL,
                                              true);

Then, we check the attributes:

assert(customOptions.maxLineLength() == 200);
assert(customOptions.alphabet()      == bdlde::Base64Alphabet::e_URL);
assert(customOptions.isPadded()      == true);

Now, we stream the object:

cout << customOptions << endl;

Finally, we observe the output:

[ maxLineLength = 200 alphabet = URL isPadded = true ]