Struct DecodeLifecycleProgress 

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

Main decoded value and lifecycle output lengths written to caller storage.

Type Parameters

• V: Logical value type produced by the codec.

Examples

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

use qubit_codec::Codec;
use qubit_codec::CodecValueDecoder;
use qubit_codec::DecodeFailure;
use qubit_codec::DecodeLifecycleProgress;

struct ByteCodec;
impl Codec for ByteCodec {
    type Value = u8;
    type Unit = u8;
    type DecodeError = Infallible;
    type EncodeError = Infallible;
    const MIN_UNITS_PER_VALUE: usize = 1;
    const MAX_ENCODE_UNITS_PER_VALUE: usize = 1;
    const MAX_DECODE_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 mut decoder = CodecValueDecoder::new(ByteCodec);
let progress: DecodeLifecycleProgress<u8> = decoder
    .decode_lifecycle_with_scratch(&[42], &mut [], &mut [])
    .unwrap();
assert_eq!(*progress.value(), 42);
assert_eq!(progress.reset_written(), 0);
assert_eq!(progress.finish_written(), 0);

Implementations

impl<V> DecodeLifecycleProgress<V>

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 const fn reset_written(&self) -> usize

Returns the number of reset values written to caller storage.

Returns

Returns the initialized reset output length.

pub const fn finish_written(&self) -> usize

Returns the number of finish values written to caller storage.

Returns

Returns the initialized finish output length.

pub fn into_parts(self) -> (V, usize, usize)

Consumes this progress and returns its components.

Returns

Returns the main value, reset output length, and finish output length.

Trait Implementations

impl<V: Clone> Clone for DecodeLifecycleProgress<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: Copy> Copy for DecodeLifecycleProgress<V>

impl<V: Debug> Debug for DecodeLifecycleProgress<V>

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

Formats the value using the given formatter.

impl<V: Eq> Eq for DecodeLifecycleProgress<V>

impl<V: Hash> Hash for DecodeLifecycleProgress<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 DecodeLifecycleProgress<V>

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

Equality operator ==.

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

Inequality operator !=.

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