Struct EncodeContext 

pub struct EncodeContext<'a, Value> { /* private fields */ }

Read-only context supplied to an encode policy hook.

The engine retains ownership of the mutable output slice. Hooks can inspect the current value and cursor/capacity metadata, then return an crate::engine::EncodeUnencodableAction without being able to mutate output behind the engine’s progress accounting.

Type Parameters

• Value: Logical input value type.

Implementations

impl<'a, Value> EncodeContext<'a, Value>

pub const fn new( input_value: &'a Value, input_index: usize, output_index: usize, available_output: usize, ) -> Self

Creates an encode policy context.

Parameters

• input_value: Borrowed input value being encoded.
• input_index: Absolute input index of input_value.
• output_index: Absolute output index where writing begins.
• available_output: Output units writable from output_index.

Returns

Returns a read-only encode context.

pub const fn input_value(&self) -> &Value

Returns the input value being encoded.

pub const fn input_index(&self) -> usize

Returns the absolute input index of the current value.

pub const fn output_index(&self) -> usize

Returns the absolute output index where writing begins.

pub const fn available_output(&self) -> usize

Returns output capacity visible to this encode attempt.

Trait Implementations

impl<'a, Value: Clone> Clone for EncodeContext<'a, Value>

fn clone(&self) -> EncodeContext<'a, Value>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, Value: Copy> Copy for EncodeContext<'a, Value>

impl<'a, Value: Debug> Debug for EncodeContext<'a, Value>

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

Formats the value using the given formatter.

impl<'a, Value: Eq> Eq for EncodeContext<'a, Value>

impl<'a, Value: Hash> Hash for EncodeContext<'a, Value>

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<'a, Value: PartialEq> PartialEq for EncodeContext<'a, Value>

fn eq(&self, other: &EncodeContext<'a, Value>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<'a, Value: PartialEq> StructuralPartialEq for EncodeContext<'a, Value>