Trait Storable 

pub trait Storable {
    const BOUND: Bound;

    // Required methods
    fn to_bytes(&self) -> Cow<'_, [u8]>;
    fn into_bytes(self) -> Vec<u8> ;
    fn from_bytes(bytes: Cow<'_, [u8]>) -> Self;

    // Provided methods
    fn to_bytes_checked(&self) -> Cow<'_, [u8]> { ... }
    fn into_bytes_checked(self) -> Vec<u8> 
       where Self: Sized { ... }
    fn check_bounds(bytes: &[u8]) { ... }
}

A trait with convenience methods for storing an element into a stable structure.

Required Associated Constants

const BOUND: Bound

The size bounds of the type.

Required Methods

fn to_bytes(&self) -> Cow<'_, [u8]>

Converts the element into a possibly borrowed byte slice.

NOTE: Cow is used here to avoid unnecessary cloning.

fn into_bytes(self) -> Vec<u8>

Converts the element into an owned byte vector.

This method consumes self and avoids cloning when possible.

fn from_bytes(bytes: Cow<'_, [u8]>) -> Self

Converts bytes into an element.

Provided Methods

fn to_bytes_checked(&self) -> Cow<'_, [u8]>

Like to_bytes, but checks that bytes conform to declared bounds.

fn into_bytes_checked(self) -> Vec<u8>

where Self: Sized,

Like into_bytes, but checks that bytes conform to declared bounds.

fn check_bounds(bytes: &[u8])

Validates that a byte slice fits within this type’s declared bounds.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementations on Foreign Types

impl Storable for ()

const BOUND: Bound

fn to_bytes(&self) -> Cow<'_, [u8]>

fn into_bytes(self) -> Vec<u8>

fn from_bytes(bytes: Cow<'_, [u8]>)

impl Storable for StableCellLedgerRecord

const BOUND: Bound = Bound::Unbounded

fn to_bytes(&self) -> Cow<'_, [u8]>

fn into_bytes(self) -> Vec<u8>

fn from_bytes(bytes: Cow<'_, [u8]>) -> StableCellLedgerRecord

impl Storable for String

const BOUND: Bound = Bound::Unbounded

fn to_bytes(&self) -> Cow<'_, [u8]>

fn into_bytes(self) -> Vec<u8>

fn from_bytes(bytes: Cow<'_, [u8]>) -> String

impl Storable for Vec<u8>

const BOUND: Bound = Bound::Unbounded

fn to_bytes(&self) -> Cow<'_, [u8]>

fn into_bytes(self) -> Vec<u8>

fn from_bytes(bytes: Cow<'_, [u8]>) -> Vec<u8>

impl Storable for bool

const BOUND: Bound

fn to_bytes(&self) -> Cow<'_, [u8]>

fn into_bytes(self) -> Vec<u8>

fn from_bytes(bytes: Cow<'_, [u8]>) -> bool

impl Storable for f32

const BOUND: Bound

fn to_bytes(&self) -> Cow<'_, [u8]>

fn into_bytes(self) -> Vec<u8>

fn from_bytes(bytes: Cow<'_, [u8]>) -> f32

impl Storable for f64

const BOUND: Bound

fn to_bytes(&self) -> Cow<'_, [u8]>

fn into_bytes(self) -> Vec<u8>

fn from_bytes(bytes: Cow<'_, [u8]>) -> f64

impl Storable for u8

const BOUND: Bound

fn to_bytes(&self) -> Cow<'_, [u8]>

fn into_bytes(self) -> Vec<u8>

fn from_bytes(bytes: Cow<'_, [u8]>) -> u8

impl Storable for u16

const BOUND: Bound

fn to_bytes(&self) -> Cow<'_, [u8]>

fn into_bytes(self) -> Vec<u8>

fn from_bytes(bytes: Cow<'_, [u8]>) -> u16

impl Storable for u32

const BOUND: Bound

fn to_bytes(&self) -> Cow<'_, [u8]>

fn into_bytes(self) -> Vec<u8>

fn from_bytes(bytes: Cow<'_, [u8]>) -> u32

impl Storable for u64

const BOUND: Bound

fn to_bytes(&self) -> Cow<'_, [u8]>

fn into_bytes(self) -> Vec<u8>

fn from_bytes(bytes: Cow<'_, [u8]>) -> u64

impl Storable for u128

const BOUND: Bound

fn to_bytes(&self) -> Cow<'_, [u8]>

fn into_bytes(self) -> Vec<u8>

fn from_bytes(bytes: Cow<'_, [u8]>) -> u128

impl<A, B, C> Storable for (A, B, C)

where A: Storable, B: Storable, C: Storable,

const BOUND: Bound

fn to_bytes(&self) -> Cow<'_, [u8]>

fn into_bytes(self) -> Vec<u8>

fn from_bytes(bytes: Cow<'_, [u8]>) -> (A, B, C)

impl<A, B> Storable for (A, B)

where A: Storable, B: Storable,

const BOUND: Bound

fn to_bytes(&self) -> Cow<'_, [u8]>

fn into_bytes(self) -> Vec<u8>

fn from_bytes(bytes: Cow<'_, [u8]>) -> (A, B)

impl<T> Storable for Option<T>

where T: Storable,

const BOUND: Bound

fn to_bytes(&self) -> Cow<'_, [u8]>

fn into_bytes(self) -> Vec<u8>

fn from_bytes(bytes: Cow<'_, [u8]>) -> Option<T>

impl<T> Storable for Reverse<T>

where T: Storable,

const BOUND: Bound = T::BOUND

fn to_bytes(&self) -> Cow<'_, [u8]>

fn into_bytes(self) -> Vec<u8>

fn from_bytes(bytes: Cow<'_, [u8]>) -> Reverse<T>

impl<const N: usize> Storable for [u8; N]

const BOUND: Bound

fn to_bytes(&self) -> Cow<'_, [u8]>

fn into_bytes(self) -> Vec<u8>

fn from_bytes(bytes: Cow<'_, [u8]>) -> [u8; N]

Implementors

impl Storable for CanisterRole

const BOUND: Bound

impl Storable for Cycles

const BOUND: Bound

impl Storable for IntentId

const BOUND: Bound

impl Storable for Principal

const BOUND: Bound

impl Storable for SubnetRole

const BOUND: Bound

impl<const N: u32> Storable for BoundedString<N>

const BOUND: Bound

impl<const N: usize> Storable for Blob<N>

const BOUND: Bound

impl<const N: usize> Storable for BoundedVecN<N>

const BOUND: Bound

impl<const N: usize> Storable for UnboundedVecN<N>

const BOUND: Bound = Bound::Unbounded