Struct CodecBufferedEncoder 

pub struct CodecBufferedEncoder<C> { /* private fields */ }

Encodes values into caller-provided output units by using a Codec.

CodecBufferedEncoder is the default bridge from the low-level unchecked Codec contract to the buffered BufferedTranscoder and BufferedEncoder contracts. It encodes complete values only; when the remaining output capacity is smaller than codec.max_units_per_value(), it stops before consuming the next input value and reports crate::TranscodeStatus::NeedOutput.

Type Parameters

• C: Low-level codec used to encode values.

Implementations

impl<C> CodecBufferedEncoder<C>

where C: Codec,

pub const fn new(codec: C) -> Self

Creates a buffered encoder backed by codec.

Parameters

• codec: Low-level codec used to encode values.

Returns

Returns a buffered encoder adapter for the supplied codec.

Trait Implementations

impl<C> BufferedEncoder<<C as Codec>::Value, <C as Codec>::Unit> for CodecBufferedEncoder<C>

where C: Codec,

impl<C> BufferedTranscoder<<C as Codec>::Value, <C as Codec>::Unit> for CodecBufferedEncoder<C>

where C: Codec,

fn max_output_len(&self, input_len: usize) -> Result<usize, CapacityError>

Returns the maximum number of output units needed for input_len values.

Parameters

• input_len: Logical input values the caller plans to encode.

Returns

Returns a conservative upper bound for output units.

fn max_finish_output_len(&self) -> Result<usize, CapacityError>

Returns the maximum units emitted by finishing internal state.

Returns

Returns the number of units that may be emitted by finishing state.

fn reset(&mut self)

Resets hook-owned state.

Returns

Returns unit ().

fn transcode( &mut self, input: &[C::Value], input_index: usize, output: &mut [C::Unit], output_index: usize, ) -> Result<TranscodeProgress, Self::Error>

Encodes values into the supplied output buffer.

Parameters

• input: Input value slice.
• input_index: Absolute input index where encoding starts.
• output: Destination unit slice.
• output_index: Absolute output index where writing starts.

Returns

Returns conversion progress for consumed input and produced output units.

Errors

Returns an encode error when indices are invalid or when encoding cannot continue under current policy.

fn finish( &mut self, output: &mut [C::Unit], output_index: usize, ) -> Result<usize, FinishError<Self::Error>>

Finishes internally retained output after EOF.

Parameters

• output: Destination unit slice for finalization output.
• output_index: Absolute output index where writing starts.

Returns

Returns the number of units written by finalization.

Errors

Returns a finish error if retained output cannot be fully emitted.

type Error = CodecEncodeError<<C as Codec>::EncodeError>

Error reported for semantic conversion failures.

impl<C: Clone> Clone for CodecBufferedEncoder<C>

fn clone(&self) -> CodecBufferedEncoder<C>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<C: Copy> Copy for CodecBufferedEncoder<C>

impl<C: Debug> Debug for CodecBufferedEncoder<C>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<C: Default> Default for CodecBufferedEncoder<C>

fn default() -> CodecBufferedEncoder<C>

Returns the “default value” for a type.

impl<C: Eq> Eq for CodecBufferedEncoder<C>

impl<C: Hash> Hash for CodecBufferedEncoder<C>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<C: PartialEq> PartialEq for CodecBufferedEncoder<C>

fn eq(&self, other: &CodecBufferedEncoder<C>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<C> StructuralPartialEq for CodecBufferedEncoder<C>