Struct gear_core::pages::GearPage

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

Page number.

Trait Implementations

impl Clone for GearPage

fn clone(&self) -> GearPage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GearPage

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

Formats the value using the given formatter.

impl Decode for GearPage

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 Default for GearPage

fn default() -> GearPage

Returns the “default value” for a type.

impl Encode for GearPage

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 From<GearPage> for u32

fn from(value: GearPage) -> Self

Converts to this type from the input type.

impl From<u16> for GearPage

fn from(value: u16) -> Self

Converts to this type from the input type.

impl Hash for GearPage

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 Ord for GearPage

fn cmp(&self, other: &GearPage) -> 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 PageDynSize for GearPage

const SIZE_NO: usize = 1usize

Returns size number of page.

fn size<S: SizeManager>(ctx: &S) -> u32

Returns size of page.

fn new<S: SizeManager>(raw: u32, ctx: &S) -> Option<Self>

Creates page from raw number with specific context and checks that page number is valid. Returns None if page number is invalid.

fn offset<S: SizeManager>(&self, ctx: &S) -> u32

Returns offset of page.

fn end_offset<S: SizeManager>(&self, ctx: &S) -> u32

Returns offset of end of page.

fn from_offset<S: SizeManager>(ctx: &S, offset: u32) -> Self

Creates page from offset.

impl PageNumber for GearPage

unsafe fn from_raw(raw: u32) -> Self

Creates page from raw number.

fn raw(&self) -> u32

Returns raw (u32) page number.

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

Checked subtraction.

fn iter_end_inclusive( &self, end: Self ) -> Result<PagesIterInclusive<Self>, PageError>

Returns iterator self..=end.

impl PageU32Size for GearPage

fn size_non_zero() -> NonZeroU32

Returns size of page.

unsafe fn new_unchecked(num: u32) -> Self

Constructs new page without any checks.

fn size() -> u32

Size as u32. Cannot be zero, because uses Self::size_non_zero.

fn from_offset(offset: u32) -> Self

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

fn new(num: u32) -> Result<Self, PageError>

Constructs new page from raw page number with checks. Returns error if page will contain bytes, with offsets bigger then u32::MAX.

fn offset(&self) -> u32

Returns page zero byte offset.

fn end_offset(&self) -> u32

Returns page last byte offset.

fn to_page<P1: PageU32Size>(&self) -> P1

Returns new page, which contains self zero byte.

fn to_last_page<P1: PageU32Size>(&self) -> P1

Returns new page, which contains self last byte.

fn add_raw(&self, raw: u32) -> Result<Self, PageError>

Returns page which has number page.raw() + raw, with checks.

fn sub_raw(&self, raw: u32) -> Result<Self, PageError>

Returns page which has number page.raw() - raw, with checks.

fn add(&self, other: Self) -> Result<Self, PageError>

Returns page which has number page.raw() + other.raw(), with checks.

fn sub(&self, other: Self) -> Result<Self, PageError>

Returns page which has number page.raw() - other.raw(), with checks.

fn inc(&self) -> Result<Self, PageError>

Returns page which has number page.raw() + 1, with checks.

fn dec(&self) -> Result<Self, PageError>

Returns page which has number page.raw() - 1, with checks.

fn align_down(&self, size: NonZeroU32) -> Self

Aligns page zero byte and returns page which contains this byte. Normally if size % Self::size() == 0, then aligned byte is zero byte of the returned page.

fn zero() -> Self

Returns page, which has zero byte offset == 0.

fn iter_count(&self, count: Self) -> Result<PagesIter<Self>, PageError>

Returns iterator self..self + count.

fn iter_end(&self, end: Self) -> Result<PagesIter<Self>, PageError>

Returns iterator self..end.

fn iter_from_zero_inclusive(&self) -> PagesIterInclusive<Self>

Returns iterator 0..=self

fn iter_from_zero(&self) -> PagesIter<Self>

Returns iterator 0..self

fn iter_once(&self) -> PagesIterInclusive<Self>

Returns iterator self..=self

fn to_pages_iter<P: PageU32Size>(&self) -> PagesIterInclusive<P>

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

impl PartialEq for GearPage

fn eq(&self, other: &GearPage) -> 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 GearPage

fn partial_cmp(&self, other: &GearPage) -> 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 TypeInfo for GearPage

type Identity = GearPage

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl Copy for GearPage

impl EncodeLike for GearPage

impl Eq for GearPage

impl StructuralPartialEq for GearPage