Struct hammersbald::PRef

pub struct PRef(_);

Pointer to persistent data. Limited to 2^48

Methods

impl PRef

pub fn invalid() -> PRef

construct an invalid pref

pub fn is_valid(&self) -> bool

is this a valid pref?

pub fn as_u64(&self) -> u64

convert to a number

pub fn this_page(&self) -> PRef

pref of the page of this pref

pub fn page_number(&self) -> u64

compute page number of an pref

pub fn in_page_pos(&self) -> usize

position within the pref's page

pub fn pages_until(&self, other: PRef) -> usize

number of pages from this until an other

pub fn next_page(&self) -> PRef

next page

pub fn prev_page(&self) -> PRef

previous page

pub fn add_pages(&self, n: usize) -> PRef

add n pages

Trait Implementations

impl PartialOrd<PRef> for PRef

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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 PartialEq<PRef> for PRef

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

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

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

This method tests for !=.

impl Copy for PRef

impl Ord for PRef

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl Eq for PRef

impl Default for PRef

fn default() -> Self

Returns the "default value" for a type.

impl From<u64> for PRef

fn from(n: u64) -> Self

Performs the conversion.

impl Clone for PRef

fn clone(&self) -> PRef

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Hash for PRef

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, 

Feeds a slice of this type into the given [Hasher].

impl Add<u64> for PRef

type Output = PRef

The resulting type after applying the + operator.

fn add(self, rhs: u64) -> Self::Output

Performs the + operation.

impl Sub<u64> for PRef

type Output = PRef

The resulting type after applying the - operator.

fn sub(self, rhs: u64) -> Self::Output

Performs the - operation.

impl AddAssign<u64> for PRef

fn add_assign(&mut self, rhs: u64)

Performs the += operation.

impl SubAssign<u64> for PRef

fn sub_assign(&mut self, rhs: u64)

Performs the -= operation.

impl Debug for PRef

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

Formats the value using the given formatter.

impl Display for PRef

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

Formats the value using the given formatter.