Struct miri::concurrency::vector_clock::VClock

pub struct VClock(SmallVec<[u32; 4]>);

A vector clock for detecting data-races, this is conceptually a map from a vector index (and thus a thread id) to a timestamp. The compare operations require that the invariant that the last element in the internal timestamp slice must not be a 0, hence all zero vector clocks are always represented by the empty slice; and allows for the implementation of compare operations to short circuit the calculation and return the correct result faster, also this means that there is only one unique valid length for each set of vector clock values and hence the PartialEq and Eq derivations are correct.

Tuple Fields

0: SmallVec<[u32; 4]>

Implementations

impl VClock

pub fn new_with_index(index: VectorIdx, timestamp: u32) -> VClock

Create a new vector-clock containing all zeros except for a value at the given index

pub fn as_slice(&self) -> &[u32]

Load the internal timestamp slice in the vector clock

fn get_mut_with_min_len(&mut self, min_len: usize) -> &mut [u32]

Get a mutable slice to the internal vector with minimum min_len elements, to preserve invariants this vector must modify the min_len-1 nth element to a non-zero value

pub fn increment_index(&mut self, idx: VectorIdx)

Increment the vector clock at a known index this will panic if the vector index overflows

pub fn join(&mut self, other: &Self)

pub fn set_at_index(&mut self, other: &Self, idx: VectorIdx)

Set the element at the current index of the vector

pub fn set_zero_vector(&mut self)

Set the vector to the all-zero vector

pub fn is_zero_vector(&self) -> bool

Return if this vector is the all-zero vector

Trait Implementations

impl Clone for VClock

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VClock

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

Formats the value using the given formatter.

impl Default for VClock

fn default() -> VClock

Returns the “default value” for a type.

impl Index<VectorIdx> for VClock

type Output = u32

The returned type after indexing.

fn index(&self, index: VectorIdx) -> &u32

Performs the indexing (container[index]) operation.

impl PartialEq<VClock> for VClock

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

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

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

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

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

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

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

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

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

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

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

impl Eq for VClock

impl StructuralEq for VClock

impl StructuralPartialEq for VClock

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference’s “Type Layout” chapter for details on type layout guarantees.

Size: 32 bytes