Struct PagesAmount

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

Struct represents memory pages amount 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 one or zero bytes.

Implementations

impl<const SIZE: u32> PagesAmount<SIZE>

pub const SIZE: u32 = SIZE

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

NOTE: In case SIZE == 0 or 1 or any not power of two number, then you would receive compilation error.

pub const UPPER: Self = _

Number of max pages amount. Equal to max page number + 1.

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

pub fn to_page_number(&self) -> Option<Page<SIZE>>

Get page number, which bounds this pages amount. If pages amount == 4GB size, then returns None, because such page number does not exist.

pub fn to_pages_amount<const S: u32>(&self) -> PagesAmount<S>

Returns corresponding amount of pages with another size S.

pub fn offset(&self) -> u64

Returns amount in bytes. Can be also considered as offset of a page with corresponding number. In 32-bits address space it can be up to u32::MAX + 1, so we returns u64 to prevent overflow.

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 PagesAmount<SIZE>

fn clone(&self) -> PagesAmount<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 PagesAmount<SIZE>

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

Formats the value using the given formatter.

impl<const SIZE: u32> Decode for PagesAmount<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 PagesAmount<SIZE>

fn default() -> PagesAmount<SIZE>

Returns the “default value” for a type.

impl<const SIZE: u32> Encode for PagesAmount<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<Option<Page<SIZE>>> for PagesAmount<SIZE>

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

Converts to this type from the input type.

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<PagesAmount<SIZE>> for u32

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

Converts to this type from the input type.

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

fn cmp(&self, other: &PagesAmount<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 PagesAmount<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> 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 PagesAmount<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> TryFrom<u32> for PagesAmount<SIZE>

type Error = PagesAmountError

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 PagesAmount<SIZE>

type Identity = PagesAmount<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> Copy for PagesAmount<SIZE>

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

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

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