Struct RingState 

pub struct RingState { /* private fields */ }

Represents the state tracking structure for the ring buffer.

Implementations

impl RingState

pub const DELAY: usize = 16usize

Represents the delay until the next check.

pub const EIDX_TERM: usize = 0usize

Represents an queue index to terminate a dequeue operation.

pub const EIDX_DEQ: usize = 1usize

Represents an queue index for a dequeue operation.

pub const fn new() -> Self

Creates a new RingState.

pub unsafe fn next(&self) -> &AtomicPtr<Self>

Gets a reference to the next RingState.

Safety

Caller must ensure next lifetime is at least as long as this RingState.

pub unsafe fn load_next(&self) -> *mut Self

Gets a pointer to the next RingState.

Safety

Caller must ensure next lifetime is at least as long as this RingState.

pub unsafe fn set_next(&self, val: *mut Self)

Sets the next RingState.

Safety

Caller must ensure val lifetime is at least as long as this RingState.

pub fn unset_next(&self)

Unsets the next RingState.

pub const fn next_check(&self) -> &AtomicUsize

Gets a reference to the next check value.

pub fn load_next_check(&self) -> usize

Gets the next check value.

pub fn set_next_check(&self, val: usize)

Sets the next check value.

pub unsafe fn curr_thread(&self) -> &AtomicPtr<Self>

Gets a reference to the current thread RingState.

Safety

Caller must ensure curr_thread lifetime is at least as long as this RingState.

pub unsafe fn load_curr_thread(&self) -> *mut Self

Gets a pointer to the current thread RingState.

Safety

Caller must ensure curr_thread lifetime is at least as long as this RingState.

pub unsafe fn set_curr_thread(&self, val: *mut Self)

Sets the current thread RingState.

Safety

Caller must ensure val lifetime is at least as long as this RingState.

pub fn unset_curr_thread(&self)

Unsets the current thread RingState.

pub const fn phase2(&self) -> &RingPhase2

Gets a reference to the phase2 value.

pub fn phase2_mut(&mut self) -> &mut RingPhase2

Gets a mutable reference to the phase2 value.

pub fn set_phase2(&mut self, val: RingPhase2)

Sets the phase2 value.

pub const fn seq1(&self) -> &Atomic

Gets a reference to the first sequence value.

pub fn load_seq1(&self) -> Uint

Gets the first sequence value.

pub fn set_seq1(&self, val: Uint)

Sets the first sequence value.

pub const fn tail(&self) -> &Atomic

Gets a reference to the tail value.

pub fn load_tail(&self) -> Uint

Gets the tail value.

pub fn set_tail(&self, val: Uint)

Sets the tail value.

pub const fn init_tail(&self) -> &Atomic

Gets a reference the init tail value.

pub fn load_init_tail(&self) -> Uint

Gets the init tail value.

pub fn set_init_tail(&self, val: Uint)

Sets the init tail value.

pub const fn head(&self) -> &Atomic

Gets a reference to the head value.

pub fn load_head(&self) -> Uint

Gets a reference to the head value.

pub fn set_head(&self, val: Uint)

Sets the head value.

pub const fn init_head(&self) -> &Atomic

Gets a reference to the init head value.

pub fn load_init_head(&self) -> Uint

Gets the init head value.

pub fn set_init_head(&self, val: Uint)

Sets the init head value.

pub fn eidx(&self) -> &AtomicUsize

Gets a reference to the enqueue index value.

pub fn load_eidx(&self) -> usize

Gets enqueue index value.

pub fn set_eidx(&self, val: usize)

Sets the enqueue index value.

pub const fn seq2(&self) -> &Atomic

Gets a reference to the second sequence value.

pub fn load_seq2(&self) -> Uint

Gets the second sequence value.

pub fn set_seq2(&self, val: Uint)

Sets the second sequence value.

pub fn thread_id(&self) -> &AtomicUsize

Gets a reference to the thread ID value.

pub fn load_thread_id(&self) -> usize

Gets thread ID value.

pub fn set_thread_id(&self, val: usize)

Sets the thread ID value.

Trait Implementations

impl Debug for RingState

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

Formats the value using the given formatter.

impl Default for RingState

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for RingState

fn eq(&self, oth: &Self) -> 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.