Struct Page

pub struct Page<PageDataSize: Get<u32>> {
    pub page_version: PageVersion,
    pub schema_id: Option<SchemaId>,
    pub nonce: PageNonce,
    pub data: BoundedVec<u8, PageDataSize>,
}

A generic page of data which supports both Itemized and Paginated

Fields

page_version: PageVersion

Page “header” version This field should always be first in the page as the structure evolves, so pallet reads can adapt to evolving page structure.

schema_id: Option<SchemaId>

SchemaId used to serialize this page’s data. Use None for Itemized pages (schema_id will be per-item)

nonce: PageNonce

Incremental nonce to eliminate of signature replay attacks

data: BoundedVec<u8, PageDataSize>

Data for the page

• Itemized is limited by Config::MaxItemizedPageSizeBytes
• Paginated is limited by Config::MaxPaginatedPageSizeBytes

Implementations

impl<PageDataSize: Get<u32>> Page<PageDataSize>

pub fn is_empty(&self) -> bool

Check if the page is empty

pub fn get_hash(&self) -> PageHash

Retrieve the hash of the page

Trait Implementations

impl<PageDataSize: Get<u32>> Debug for Page<PageDataSize>

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

Formats the value using the given formatter.

impl<PageDataSize: Get<u32>> Decode for Page<PageDataSize>

where BoundedVec<u8, PageDataSize>: Decode,

fn decode<__CodecInputEdqy: Input>( __codec_input_edqy: &mut __CodecInputEdqy, ) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self>, ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

fn skip<I>(input: &mut I) -> Result<(), Error>

where I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<PageDataSize: Default + Get<u32>> Default for Page<PageDataSize>

fn default() -> Page<PageDataSize>

Returns the “default value” for a type.

impl<PageDataSize: Get<u32>> Encode for Page<PageDataSize>

where BoundedVec<u8, PageDataSize>: Encode,

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode_to<__CodecOutputEdqy: Output + ?Sized>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy, )

Convert self to a slice and append it to the destination.

fn encode(&self) -> Vec<u8>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> R

where F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<PageDataSize: Get<u32>> From<BoundedVec<u8, PageDataSize>> for Page<PageDataSize>

Deserializing a Page from a BoundedVec is used for the input payload, and also for rebuilding an Itemized page after applying actions– so there is no schema_id and no nonce to be read, just the raw data. The rest of the metadata gets filled in before the new/updated page is written.

fn from(bounded: BoundedVec<u8, PageDataSize>) -> Self

Converts to this type from the input type.

impl<PageDataSize: Get<u32>> Hash for Page<PageDataSize>

PartialEq and Hash should be both derived or implemented manually based on clippy rules

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<PageDataSize: Get<u32>> Into<Page<PageDataSize>> for (Option<SchemaId>, Page<PageDataSize>)

fn into(self) -> PageV2<PageDataSize>

Converts this type into the (usually inferred) input type.

impl<PageDataSize> MaxEncodedLen for Page<PageDataSize>

where PageDataSize: MaxEncodedLen + Get<u32>,

fn max_encoded_len() -> usize

Upper bound, in bytes, of the maximum encoded size of this item.

impl<PageDataSize: Get<u32>> PartialEq for Page<PageDataSize>

PartialEq and Hash should be both derived or implemented manually based on clippy rules

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<PageDataSize> TypeInfo for Page<PageDataSize>

where BoundedVec<u8, PageDataSize>: TypeInfo + 'static, PageDataSize: Get<u32> + 'static,

type Identity = Page<PageDataSize>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<PageDataSize: Get<u32>> EncodeLike for Page<PageDataSize>

where BoundedVec<u8, PageDataSize>: Encode,