Struct ssz::SszDecoder

source ·
pub struct SszDecoder<'a> { /* private fields */ }
Expand description

Decodes some slices of SSZ into object instances. Should be instantiated using SszDecoderBuilder.

§Example

use ssz_derive::{Encode, Decode};
use ssz::{Decode, Encode, SszDecoder, SszDecoderBuilder};

#[derive(PartialEq, Debug, Encode, Decode)]
struct Foo {
    a: u64,
    b: Vec<u16>,
}

fn ssz_decoding_example() {
    let foo = Foo {
        a: 42,
        b: vec![1, 3, 3, 7]
    };

    let bytes = foo.as_ssz_bytes();

    let mut builder = SszDecoderBuilder::new(&bytes);

    builder.register_type::<u64>().unwrap();
    builder.register_type::<Vec<u16>>().unwrap();

    let mut decoder = builder.build().unwrap();

    let decoded_foo = Foo {
        a: decoder.decode_next().unwrap(),
        b: decoder.decode_next().unwrap(),
    };

    assert_eq!(foo, decoded_foo);
}

Implementations§

source§

impl<'a> SszDecoder<'a>

source

pub fn decode_next<T: Decode>(&mut self) -> Result<T, DecodeError>

Decodes the next item.

§Panics

Panics when attempting to decode more items than actually exist.

source

pub fn decode_next_with<T, F>(&mut self, f: F) -> Result<T, DecodeError>
where F: FnOnce(&'a [u8]) -> Result<T, DecodeError>,

Decodes the next item using the provided function.

Auto Trait Implementations§

§

impl<'a> Freeze for SszDecoder<'a>

§

impl<'a> RefUnwindSafe for SszDecoder<'a>

§

impl<'a> Send for SszDecoder<'a>

§

impl<'a> Sync for SszDecoder<'a>

§

impl<'a> Unpin for SszDecoder<'a>

§

impl<'a> UnwindSafe for SszDecoder<'a>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> Same for T

source§

type Output = T

Should always be Self
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.