Struct soroban_wasmi::core::Pages

pub struct Pages(/* private fields */);

An amount of linear memory pages.

Implementations

impl Pages

pub const fn max() -> Pages

The maximum amount of pages on the wasm32 target.

Note

This is the maximum since WebAssembly is a 32-bit platform and a page is 2^16 bytes in size. Therefore there can be at most 2^16 pages of a single linear memory so that all bytes are still accessible.

impl Pages

pub fn new(amount: u32) -> Option<Pages>

Creates a new amount of Pages if the amount is within bounds.

Returns None if the given amount of Pages exceeds Pages::max().

pub fn checked_add<T>(self, rhs: T) -> Option<Pages>

where T: Into<u32>,

Adds the given amount of pages to self.

Returns Some if the result is within bounds and None otherwise.

pub fn checked_sub<T>(self, rhs: T) -> Option<Pages>

where T: Into<u32>,

Substracts the given amount of pages from self.

Returns None if the subtraction underflows or the result is out of bounds.

pub fn to_bytes(self) -> Option<usize>

Returns the amount of bytes required for the amount of Pages.

Returns None if the amount of pages represented by self cannot be represented as bytes on the executing platform.

Trait Implementations

impl Clone for Pages

fn clone(&self) -> Pages

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Pages

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

Formats the value using the given formatter.

impl Default for Pages

fn default() -> Pages

Returns the “default value” for a type.

impl From<u16> for Pages

fn from(amount: u16) -> Pages

Creates an amount of Pages.

Note

This is infallible since u16 cannot represent invalid amounts of Pages. However, u16 can also not represent Pages::max().

impl Ord for Pages

fn cmp(&self, other: &Pages) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Pages

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Pages

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for Pages

impl Eq for Pages

impl StructuralEq for Pages

impl StructuralPartialEq for Pages