Struct Position 

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

The position of a word in the virtual storage.

With the notations defined in Format, let:

• w denote a word offset in a virtual page, thus between 0 and Q - 1
• p denote a page offset, thus between 0 and N - 1
• c denote the number of times a page was erased, thus between 0 and E

The position of a word is (c * N + p) * Q + w. This position monotonically increases and represents the consumed lifetime of the storage.

This type is kept abstract to avoid possible confusion with Nat and Word if they happen to have the same representation. Here is an overview of their semantics:

Name	Semantics	Arithmetic operations	Bit-wise operations
Nat	Natural numbers	Yes (no overflow)	No
Word	Word in flash	No	Yes
Position	Position in virtual storage	Yes (no overflow)	No

Implementations

impl Position

pub fn new(format: &Format, cycle: Nat, page: Nat, word: Nat) -> Position

Create a word position given its coordinates.

The coordinates of a word are:

• Its word index in its virtual page.
• Its page index in the storage.
• The number of times its page was erased.

pub fn get(self) -> Nat

Accesses the underlying position as a natural number.

pub fn index(self, format: &Format) -> StorageIndex

Returns the associated storage index.

pub fn page_begin(self, format: &Format) -> Position

Returns the beginning of the current virtual page.

pub fn next_page(self, format: &Format) -> Position

Returns the beginning of the next virtual page.

pub fn cycle(self, format: &Format) -> Nat

Returns the number of times the current page was erased.

pub fn page(self, format: &Format) -> Nat

Returns the current page index.

pub fn word(self, format: &Format) -> Nat

Returns the current word index in the page.

Trait Implementations

impl Add<u32> for Position

type Output = Position

The resulting type after applying the + operator.

fn add(self, delta: Nat) -> Position

Performs the + operation.

impl AddAssign<u32> for Position

fn add_assign(&mut self, delta: Nat)

Performs the += operation.

impl Clone for Position

fn clone(&self) -> Position

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Position

impl Debug for Position

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

Formats the value using the given formatter.

impl Eq for Position

impl Ord for Position

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

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

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

impl Sub for Position

type Output = u32

The resulting type after applying the - operator.

fn sub(self, base: Position) -> Nat

Performs the - operation.