Struct Page

pub struct Page<const SIZE: u32>(/* private fields */);

Struct represents memory page number with some constant size SIZE in bytes.

• SIZE type is u32, so page size < 4GiB (wasm32 memory size limit).
• SIZE must be power of two and must not be equal to zero bytes.
• SIZE == 1 is possible, but then you cannot use PagesAmount for these pages.

Implementations

impl<const SIZE: u32> Page<SIZE>

pub const SIZE: u32 = SIZE

Page size. May be any number power of two in interval [1, u32::MAX].

pub const UPPER: Self = _

Max possible page number in 4GB memory.

Note: const computation contains checking in order to prevent incorrect SIZE.

pub fn inc(&self) -> PagesAmount<SIZE>

Increment page number. Returns PagesAmount<SIZE>, because this allows to avoid overflows.

pub fn from_offset(offset: u32) -> Self

Constructs new page from byte offset: returns page which contains this byte.

pub fn offset(&self) -> u32

Returns page zero byte offset.

pub fn end_offset(&self) -> u32

Returns page last byte offset.

pub fn to_page<const S1: u32>(self) -> Page<S1>

Returns new page, which contains self zero byte.

pub fn to_iter<const S1: u32>(self) -> IntervalIterator<Page<S1>>

Returns an iterator that iterates over the range of pages from self to the end page, inclusive. Each iteration yields a page of type Page<S1>.

Example

use gear_core::pages::{GearPage, WasmPage};

let x: Vec<GearPage> = WasmPage::from(5).to_iter().collect();
println!("{x:?}");

For this example must be printed: [GearPage(20), GearPage(21), GearPage(22), GearPage(23)]

Trait Implementations

impl<const SIZE: u32> Bound<Page<SIZE>> for PagesAmount<SIZE>

fn unbound(self) -> Option<Page<SIZE>>

Unbound means mapping bound back to value if possible.

impl<const SIZE: u32> Clone for Page<SIZE>

fn clone(&self) -> Page<SIZE>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<const SIZE: u32> Debug for Page<SIZE>

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

Formats the value using the given formatter.

impl<const SIZE: u32> Decode for Page<SIZE>

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<const SIZE: u32> Default for Page<SIZE>

fn default() -> Page<SIZE>

Returns the “default value” for a type.

impl<const SIZE: u32> Encode for Page<SIZE>

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<__CodecOutputReturn, __CodecUsingEncodedCallback: FnOnce(&[u8]) -> __CodecOutputReturn>( &self, f: __CodecUsingEncodedCallback, ) -> __CodecOutputReturn

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

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<const SIZE: u32> From<Page<SIZE>> for PagesAmount<SIZE>

fn from(value: Page<SIZE>) -> Self

Converts to this type from the input type.

impl<const SIZE: u32> From<Page<SIZE>> for u32

fn from(original: Page<SIZE>) -> Self

Converts to this type from the input type.

impl<const SIZE: u32> LowerBounded for Page<SIZE>

fn min_value() -> Self

Returns the smallest finite number this type can represent

impl<const SIZE: u32> Numerated for Page<SIZE>

type Distance = u32

Numerate type: type that describes the distances between two values of Self.

type Bound = PagesAmount<SIZE>

Bound type: type for which any value can be mapped to Self, and also has upper value, which is bigger than any value of Self.

fn add_if_enclosed_by(self, num: Self::Distance, other: Self) -> Option<Self>

Adds num to self, if self + num is enclosed by self and other.

fn sub_if_enclosed_by(self, num: Self::Distance, other: Self) -> Option<Self>

Subtracts num from self, if self - num is enclosed by self and other.

fn distance(self, other: Self) -> Self::Distance

Returns a distance between self and other

fn inc_if_lt(self, other: Self) -> Option<Self>

Increments self, if self < other.

fn dec_if_gt(self, other: Self) -> Option<Self>

Decrements self, if self > other.

fn enclosed_by(self, a: &Self, b: &Self) -> bool

Returns true, if self is enclosed by a and b.

impl<const SIZE: u32> Ord for Page<SIZE>

fn cmp(&self, other: &Page<SIZE>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<const SIZE: u32> PartialEq<Page<SIZE>> for PagesAmount<SIZE>

fn eq(&self, other: &Page<SIZE>) -> 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<const SIZE: u32> PartialEq<PagesAmount<SIZE>> for Page<SIZE>

fn eq(&self, other: &PagesAmount<SIZE>) -> 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<const SIZE: u32> PartialEq for Page<SIZE>

fn eq(&self, other: &Page<SIZE>) -> 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<const SIZE: u32> PartialOrd<Page<SIZE>> for PagesAmount<SIZE>

fn partial_cmp(&self, other: &Page<SIZE>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<const SIZE: u32> PartialOrd<PagesAmount<SIZE>> for Page<SIZE>

fn partial_cmp(&self, other: &PagesAmount<SIZE>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<const SIZE: u32> PartialOrd for Page<SIZE>

fn partial_cmp(&self, other: &Page<SIZE>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<const SIZE: u32> TryFrom<u32> for Page<SIZE>

type Error = PageError

The type returned in the event of a conversion error.

fn try_from(raw: u32) -> Result<Self, Self::Error>

Performs the conversion.

impl<const SIZE: u32> TypeInfo for Page<SIZE>

type Identity = Page<SIZE>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<const SIZE: u32> UpperBounded for Page<SIZE>

fn max_value() -> Self

Returns the largest finite number this type can represent

impl<const SIZE: u32> Copy for Page<SIZE>

impl<const SIZE: u32> EncodeLike for Page<SIZE>

impl<const SIZE: u32> Eq for Page<SIZE>

impl<const SIZE: u32> StructuralPartialEq for Page<SIZE>