Trait SerializableState

Source

pub trait SerializableStatewhere
    Self: Sized,{
    type SerializedStateSize: ArraySize;

    // Required methods
    fn serialize(&self) -> SerializedState<Self>;
    fn deserialize(
        serialized_state: &SerializedState<Self>,
    ) -> Result<Self, DeserializeStateError>;
}

Expand description

Types which can serialize the internal state and be restored from it.

§Compatibility

Serialized state can be assumed to be stable across backwards compatible versions of an implementation crate, i.e. any 0.x.y version of a crate should be able to decode data serialized with any other 0.x.z version, but it may not be able to correctly decode data serialized with a non-x version.

This guarantee is a subject to issues such as security fixes.

§SECURITY WARNING

Serialized state may contain sensitive data.

Required Associated Types§

Source

type SerializedStateSize: ArraySize

Size of serialized internal state.

Required Methods§

Source

fn serialize(&self) -> SerializedState<Self>

Serialize and return internal state.

Source

fn deserialize( serialized_state: &SerializedState<Self>, ) -> Result<Self, DeserializeStateError>

Create an object from serialized internal state.

§Errors

If the serialized state could not be deserialized successfully.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Trait SerializableState Copy item path

§Compatibility

§SECURITY WARNING

Required Associated Types§

type SerializedStateSize: ArraySize

Required Methods§

fn serialize(&self) -> SerializedState<Self>

fn deserialize( serialized_state: &SerializedState<Self>, ) -> Result<Self, DeserializeStateError>

§Errors

Dyn Compatibility§

Implementations on Foreign Types§

impl SerializableState for u8

type SerializedStateSize = UInt<UTerm, B1>

fn serialize(&self) -> SerializedState<Self>

fn deserialize( serialized_state: &SerializedState<Self>, ) -> Result<Self, DeserializeStateError>

impl SerializableState for u16

type SerializedStateSize = UInt<UInt<UTerm, B1>, B0>

fn serialize(&self) -> SerializedState<Self>

fn deserialize( serialized_state: &SerializedState<Self>, ) -> Result<Self, DeserializeStateError>

impl SerializableState for u32

type SerializedStateSize = UInt<UInt<UInt<UTerm, B1>, B0>, B0>

fn serialize(&self) -> SerializedState<Self>

fn deserialize( serialized_state: &SerializedState<Self>, ) -> Result<Self, DeserializeStateError>

impl SerializableState for u64

type SerializedStateSize = UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>

fn serialize(&self) -> SerializedState<Self>

fn deserialize( serialized_state: &SerializedState<Self>, ) -> Result<Self, DeserializeStateError>

impl SerializableState for u128

type SerializedStateSize = UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>

fn serialize(&self) -> SerializedState<Self>

fn deserialize( serialized_state: &SerializedState<Self>, ) -> Result<Self, DeserializeStateError>

impl SerializableState for [u8; 1]

type SerializedStateSize = UInt<UTerm, B1>

fn serialize(&self) -> SerializedState<Self>

fn deserialize( serialized_state: &SerializedState<Self>, ) -> Result<Self, DeserializeStateError>

impl SerializableState for [u8; 2]

type SerializedStateSize = UInt<UInt<UTerm, B1>, B0>

fn serialize(&self) -> SerializedState<Self>

fn deserialize( serialized_state: &SerializedState<Self>, ) -> Result<Self, DeserializeStateError>

impl SerializableState for [u8; 3]

type SerializedStateSize = UInt<UInt<UTerm, B1>, B1>

fn serialize(&self) -> SerializedState<Self>

fn deserialize( serialized_state: &SerializedState<Self>, ) -> Result<Self, DeserializeStateError>

impl SerializableState for [u8; 4]

type SerializedStateSize = UInt<UInt<UInt<UTerm, B1>, B0>, B0>

fn serialize(&self) -> SerializedState<Self>

fn deserialize( serialized_state: &SerializedState<Self>, ) -> Result<Self, DeserializeStateError>

impl SerializableState for [u8; 5]

type SerializedStateSize = UInt<UInt<UInt<UTerm, B1>, B0>, B1>

fn serialize(&self) -> SerializedState<Self>

fn deserialize( serialized_state: &SerializedState<Self>, ) -> Result<Self, DeserializeStateError>

impl SerializableState for [u8; 6]

type SerializedStateSize = UInt<UInt<UInt<UTerm, B1>, B1>, B0>

fn serialize(&self) -> SerializedState<Self>

fn deserialize( serialized_state: &SerializedState<Self>, ) -> Result<Self, DeserializeStateError>

impl SerializableState for [u8; 7]

type SerializedStateSize = UInt<UInt<UInt<UTerm, B1>, B1>, B1>

fn serialize(&self) -> SerializedState<Self>

fn deserialize( serialized_state: &SerializedState<Self>, ) -> Result<Self, DeserializeStateError>

impl SerializableState for [u8; 8]

type SerializedStateSize = UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>

fn serialize(&self) -> SerializedState<Self>

fn deserialize( serialized_state: &SerializedState<Self>, ) -> Result<Self, DeserializeStateError>

impl SerializableState for [u8; 9]

type SerializedStateSize = UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B1>

fn serialize(&self) -> SerializedState<Self>

fn deserialize( serialized_state: &SerializedState<Self>, ) -> Result<Self, DeserializeStateError>

impl SerializableState for [u8; 10]

type SerializedStateSize = UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B1>, B0>

fn serialize(&self) -> SerializedState<Self>

fn deserialize( serialized_state: &SerializedState<Self>, ) -> Result<Self, DeserializeStateError>

impl SerializableState for [u8; 11]

type SerializedStateSize = UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B1>, B1>

fn serialize(&self) -> SerializedState<Self>

fn deserialize( serialized_state: &SerializedState<Self>, ) -> Result<Self, DeserializeStateError>

impl SerializableState for [u8; 12]

type SerializedStateSize = UInt<UInt<UInt<UInt<UTerm, B1>, B1>, B0>, B0>

fn serialize(&self) -> SerializedState<Self>

fn deserialize( serialized_state: &SerializedState<Self>, ) -> Result<Self, DeserializeStateError>

impl SerializableState for [u8; 13]

Trait SerializableState