encodeBufferedAsync

Encode a ByteArray using a buffer of maximum size DEFAULT_BUFFER_SIZE.

The encoding operation will allocate a single buffer, streaming encoded characters to it and flushing to action when needed. If the pre-calculated size returned by EncoderDecoder.Config.encodeOutMaxSize is less than or equal to the DEFAULT_BUFFER_SIZE, then a buffer of that size will be allocated and action is only invoked once (single-shot encoding). In the event that EncoderDecoder.Config.encodeOutMaxSize throws its EncodingSizeException (i.e. encoding would exceed Int.MAX_VALUE) while throwOnOverflow is false, or its return value is greater than DEFAULT_BUFFER_SIZE, then this function will always stream encode to a buffer while flushing to action until the encoding operation has completed.

NOTE: Documented exceptions thrown by this function do not include those for which action may throw.

NOTE: The Encoder implementation must be compatible with version 2.6.0+ APIs and define a EncoderDecoder.Config.maxEncodeEmit. If the value is -1 (i.e. it has not updated to the new API yet), then this function will fail with an EncodingException. All implementations provided by this library have been updated to meet the API requirement; only EncoderDecoder implementations external to this library that have not updated yet may fail when using them with encodeBuffered and encodeBufferedAsync APIs.

Parameters

See also

Throws

Encode len number of bytes from the array, starting at index offset, using a buffer of maximum size DEFAULT_BUFFER_SIZE.

The encoding operation will allocate a single buffer, streaming encoded characters to it and flushing to action when needed. If the pre-calculated size returned by EncoderDecoder.Config.encodeOutMaxSize is less than or equal to the DEFAULT_BUFFER_SIZE, then a buffer of that size will be allocated and action is only invoked once (single-shot encoding). In the event that EncoderDecoder.Config.encodeOutMaxSize throws its EncodingSizeException (i.e. encoding would exceed Int.MAX_VALUE) while throwOnOverflow is false, or its return value is greater than DEFAULT_BUFFER_SIZE, then this function will always stream encode to a buffer while flushing to action until the encoding operation has completed.

NOTE: Documented exceptions thrown by this function do not include those for which action may throw.

NOTE: The Encoder implementation must be compatible with version 2.6.0+ APIs and define a EncoderDecoder.Config.maxEncodeEmit. If the value is -1 (i.e. it has not updated to the new API yet), then this function will fail with an EncodingException. All implementations provided by this library have been updated to meet the API requirement; only EncoderDecoder implementations external to this library that have not updated yet may fail when using them with encodeBuffered and encodeBufferedAsync APIs.

Parameters

See also

Throws

Encode a ByteArray using a buffer of maximum size maxBufSize.

The encoding operation will allocate a single buffer, streaming encoded characters to it and flushing to action when needed. If the pre-calculated size returned by EncoderDecoder.Config.encodeOutMaxSize is less than or equal to the maxBufSize, then a buffer of that size will be allocated and action is only invoked once (single-shot encoding). In the event that EncoderDecoder.Config.encodeOutMaxSize throws its EncodingSizeException (i.e. encoding would exceed Int.MAX_VALUE) while throwOnOverflow is false, or its return value is greater than maxBufSize, then this function will always stream encode to a buffer while flushing to action until the encoding operation has completed.

NOTE: Documented exceptions thrown by this function do not include those for which action may throw.

NOTE: The Encoder implementation must be compatible with version 2.6.0+ APIs and define a EncoderDecoder.Config.maxEncodeEmit. If the value is -1 (i.e. it has not updated to the new API yet), then this function will fail with an EncodingException. All implementations provided by this library have been updated to meet the API requirement; only EncoderDecoder implementations external to this library that have not updated yet may fail when using them with encodeBuffered and encodeBufferedAsync APIs.

Parameters

See also

Throws

Encode len number of bytes from the array, starting at index offset, using a buffer of maximum size maxBufSize.

The encoding operation will allocate a single buffer, streaming encoded characters to it and flushing to action when needed. If the pre-calculated size returned by EncoderDecoder.Config.encodeOutMaxSize is less than or equal to the maxBufSize, then a buffer of that size will be allocated and action is only invoked once (single-shot encoding). In the event that EncoderDecoder.Config.encodeOutMaxSize throws its EncodingSizeException (i.e. encoding would exceed Int.MAX_VALUE) while throwOnOverflow is false, or its return value is greater than maxBufSize, then this function will always stream encode to a buffer while flushing to action until the encoding operation has completed.

NOTE: Documented exceptions thrown by this function do not include those for which action may throw.

NOTE: The Encoder implementation must be compatible with version 2.6.0+ APIs and define a EncoderDecoder.Config.maxEncodeEmit. If the value is -1 (i.e. it has not updated to the new API yet), then this function will fail with an EncodingException. All implementations provided by this library have been updated to meet the API requirement; only EncoderDecoder implementations external to this library that have not updated yet may fail when using them with encodeBuffered and encodeBufferedAsync APIs.

Parameters

See also

Throws

Encode a ByteArray using the provided pre-allocated, reusable, buf array.

The encoding operation will stream encoded characters to the provided buf, flushing to action when needed. If the pre-calculated size returned by EncoderDecoder.Config.encodeOutMaxSize is less than or equal to the buf size, then action is only invoked once (single-shot encoding). In the event that EncoderDecoder.Config.encodeOutMaxSize throws its EncodingSizeException (i.e. encoding would exceed Int.MAX_VALUE) while throwOnOverflow is false, or its return value is greater than buf size, then this function will always stream encode to a buffer while flushing to action until the encoding operation has completed.

NOTE: Documented exceptions thrown by this function do not include those for which action may throw.

NOTE: If EncoderDecoder.Config.backFillBuffers is true, provided buf array will be back-filled with null character \u0000 upon encoding completion.

NOTE: The Encoder implementation must be compatible with version 2.6.0+ APIs and define a EncoderDecoder.Config.maxEncodeEmit. If the value is -1 (i.e. it has not updated to the new API yet), then this function will fail with an EncodingException. All implementations provided by this library have been updated to meet the API requirement; only EncoderDecoder implementations external to this library that have not updated yet may fail when using them with encodeBuffered and encodeBufferedAsync APIs.

Parameters

See also

Throws

Encode len number of bytes from the array, starting at index offset, using the provided pre-allocated, reusable, buf array.

The encoding operation will stream encoded characters to the provided buf, flushing to action when needed. If the pre-calculated size returned by EncoderDecoder.Config.encodeOutMaxSize is less than or equal to the buf size, then action is only invoked once (single-shot encoding). In the event that EncoderDecoder.Config.encodeOutMaxSize throws its EncodingSizeException (i.e. encoding would exceed Int.MAX_VALUE) while throwOnOverflow is false, or its return value is greater than buf size, then this function will always stream encode to a buffer while flushing to action until the encoding operation has completed.

NOTE: Documented exceptions thrown by this function do not include those for which action may throw.

NOTE: If EncoderDecoder.Config.backFillBuffers is true, provided buf array will be back-filled with null character \u0000 upon encoding completion.

NOTE: The Encoder implementation must be compatible with version 2.6.0+ APIs and define a EncoderDecoder.Config.maxEncodeEmit. If the value is -1 (i.e. it has not updated to the new API yet), then this function will fail with an EncodingException. All implementations provided by this library have been updated to meet the API requirement; only EncoderDecoder implementations external to this library that have not updated yet may fail when using them with encodeBuffered and encodeBufferedAsync APIs.

Parameters

See also

Throws