convert overloads

Synopses

Declared in <bdlde_base64encoder.h>

Encode input bytes from [begin, end)] into Base64 at out.

template<
    class OUTPUT_ITERATOR,
    class INPUT_ITERATOR>
int
convert(
    OUTPUT_ITERATOR out,
    INPUT_ITERATOR begin,
    INPUT_ITERATOR end);

Encode input bytes from [begin, end)] into Base64 with limits.

template<
    class OUTPUT_ITERATOR,
    class INPUT_ITERATOR>
int
convert(
    OUTPUT_ITERATOR out,
    int* numOut,
    int* numIn,
    INPUT_ITERATOR begin,
    INPUT_ITERATOR end,
    int maxNumOut = ‐1);

Return Value

  • a non‐negative value on success, and a negative value otherwise

  • a non‐negative value on success (positive means retained output bytes not yet written), and a negative value otherwise

Parameters

Name

Description

out

output iterator for encoded characters

begin

beginning of the input byte range

end

end of the input byte range (one past the last byte)

numOut

optionally receives the number of output bytes produced

numIn

optionally receives the number of input bytes consumed

maxNumOut

maximum output bytes to emit; negative means no limit

Created with MrDocs