Struct CodecTranscodeEncoder 

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

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

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

Type Parameters

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

Implementations

impl<C> CodecTranscodeEncoder<C>

where C: Codec,

pub 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: Clone> Clone for CodecTranscodeEncoder<C>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C: Copy> Copy for CodecTranscodeEncoder<C>

impl<C: Debug> Debug for CodecTranscodeEncoder<C>

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

Formats the value using the given formatter.

impl<C> Default for CodecTranscodeEncoder<C>

where C: Codec + Default,

fn default() -> Self

Creates a default codec-backed buffered encoder.

Returns

Returns an encoder backed by C::default().

impl<C: Eq> Eq for CodecTranscodeEncoder<C>

impl<C: Hash> Hash for CodecTranscodeEncoder<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 CodecTranscodeEncoder<C>

fn eq(&self, other: &CodecTranscodeEncoder<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: PartialEq> StructuralPartialEq for CodecTranscodeEncoder<C>

impl<C> TranscodeEncoder<<C as Codec>::Value, <C as Codec>::Unit> for CodecTranscodeEncoder<C>

where C: Codec,

impl<C> Transcoder<<C as Codec>::Value, <C as Codec>::Unit> for CodecTranscodeEncoder<C>

where C: Codec,

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

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

Parameters

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

Returns

a conservative upper bound for output units.

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

Gets the maximum units emitted when resetting internal state.

Returns

the maximum units emitted when resetting internal state.

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

Gets the maximum units emitted by finishing internal state.

Returns

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

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

Resets hook-owned state and emits stream-start output.

fn transcode( &mut self, input: &[C::Value], input_index: usize, output: &mut [C::Unit], output_index: usize, ) -> Result<TranscodeProgress, TranscodeError<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, TranscodeError<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>

Domain error reported by semantic conversion failures.