Struct osiris_data::data::atomic::Word

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

Describes the machine’s base type. Every base operation occurs on this type.

Implementations

impl Word

pub const fn new(value: u64) -> Self

Creates a new word from its 64 bits value.

pub const fn from_usize(value: usize) -> Self

Creates a new word from its 64 bits value.

pub const fn from_be_bytes(value: [u8; 8]) -> Self

Create a native endian integer value from its representation as a byte array in big endian.

pub const fn merge(top: HalfWord, bottom: HalfWord) -> Self

Creates a new word from two half-words.

pub const fn to_u64(&self) -> u64

Returns a 64 bits value representing the word.

pub const fn to_be_bytes(&self) -> [u8; 8]

Return the memory representation of this integer as a byte array in big-endian (network) byte order.

pub const fn split(&self) -> [HalfWord; 2]

Returns two 32 bits half-words splitting the 64 bits word.

pub const fn top(&self) -> HalfWord

Returns the 32 first left bits of the word.

pub const fn bottom(&self) -> HalfWord

Returns the 32 last right bits of the word.

Trait Implementations

impl Clone for Word

fn clone(&self) -> Word

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Word

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

Formats the value using the given formatter.

impl Default for Word

fn default() -> Word

Returns the “default value” for a type.

impl Ord for Word

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

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

fn partial_cmp(&self, other: &Word) -> 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 ProduceConsume<Word> for WordQueue

fn produce(&mut self, word: Word)

Adds a word at the end of the queue.

fn consume(&mut self) -> Option<Word>

Removes and returns an item from the end of the queue.

fn len(&self) -> usize

Returns the queue length.

fn is_empty(&self) -> bool

Returns true if the queue has a zero length.

impl ProduceConsume<Word> for WordStack

fn produce(&mut self, word: Word)

Produce a value.

fn consume(&mut self) -> Option<Word>

Consume a value.

fn len(&self) -> usize

fn is_empty(&self) -> bool

impl Copy for Word

impl Eq for Word

impl StructuralPartialEq for Word