Struct DecodeLifecycleOutput 

pub struct DecodeLifecycleOutput<V> { /* private fields */ }

Values produced by decode reset, the main decode, and decode finish.

This result keeps lifecycle output in phase order without allowing finish output to overwrite reset output.

Type Parameters

• V: Logical value type produced by the codec.

Examples

A stateless identity codec produces one lifecycle whose reset and finish phases stay empty:

use core::convert::Infallible;
use core::num::NonZeroUsize;

use qubit_codec::Codec;
use qubit_codec::CodecValueDecoder;
use qubit_codec::DecodeFailure;
use qubit_codec::DecodeLifecycleOutput;

struct Identity;

impl Codec for Identity {
    type Value = u8;
    type Unit = u8;
    type DecodeError = Infallible;
    type EncodeError = Infallible;
    const MIN_UNITS_PER_VALUE: usize = 1;
    const MAX_DECODE_UNITS_PER_VALUE: usize = 1;
    const MAX_ENCODE_UNITS_PER_VALUE: usize = 1;

    unsafe fn decode(&mut self, input: &[u8], index: usize)
        -> Result<(u8, NonZeroUsize), DecodeFailure<Infallible>>
    {
        Ok((input[index], NonZeroUsize::MIN))
    }

    unsafe fn encode(&mut self, value: &u8, output: &mut [u8], index: usize)
        -> Result<usize, Infallible>
    {
        output[index] = *value;
        Ok(1)
    }
}

let output: DecodeLifecycleOutput<u8> =
    CodecValueDecoder::new(Identity).decode_lifecycle(&[7]).unwrap();
assert_eq!(*output.value(), 7);
assert!(output.reset().is_empty());
assert!(output.finish().is_empty());

let (reset, value, finish) = output.into_parts();
assert_eq!(value, 7);
assert!(reset.is_empty() && finish.is_empty());

Implementations

impl<V> DecodeLifecycleOutput<V>

pub fn reset(&self) -> &[V]

Returns values emitted while resetting decode state.

Returns

Returns the reset output in emission order.

pub const fn value(&self) -> &V

Returns the main value decoded from the supplied input.

Returns

Returns a shared reference to the main decoded value.

pub fn finish(&self) -> &[V]

Returns values emitted while finishing decode state.

Returns

Returns the finish output in emission order.

pub fn into_parts(self) -> (Vec<V>, V, Vec<V>)

Consumes this result and returns all lifecycle phases.

Returns

Returns reset values, the main decoded value, and finish values.

Trait Implementations

impl<V: Clone> Clone for DecodeLifecycleOutput<V>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<V: Debug> Debug for DecodeLifecycleOutput<V>

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

Formats the value using the given formatter.

impl<V: Eq> Eq for DecodeLifecycleOutput<V>

impl<V: Hash> Hash for DecodeLifecycleOutput<V>

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<V: PartialEq> PartialEq for DecodeLifecycleOutput<V>

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<V: PartialEq> StructuralPartialEq for DecodeLifecycleOutput<V>