Struct ThreadSyncSleep

#[repr(C)]
pub struct ThreadSyncSleep {
    pub reference: ThreadSyncReference,
    pub value: u64,
    pub op: ThreadSyncOp,
    pub flags: ThreadSyncFlags,
}

Specification for a thread sleep request.

Fields

reference: ThreadSyncReference

Reference to an atomic u64 that we will compare to.

value: u64

The value used for the comparison.

op: ThreadSyncOp

The operation to compare *reference and value to.

flags: ThreadSyncFlags

Flags to apply to this sleep request.

Implementations

impl ThreadSyncSleep

pub fn new( reference: ThreadSyncReference, value: u64, op: ThreadSyncOp, flags: ThreadSyncFlags, ) -> Self

Construct a new thread sync sleep request. The kernel will compare the 64-bit data at *reference with the passed value using op (and optionally inverting the result). If true, the kernel will put the thread to sleep until another thread comes along and performs a wake request on that same word of memory.

References always refer to a particular 64-bit value inside of an object. If a virtual address is passed as a reference, it is first converted to an object-offset pair based on the current object mapping of the address space.

pub fn ready(&self) -> bool

Trait Implementations

impl Clone for ThreadSyncSleep

fn clone(&self) -> ThreadSyncSleep

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ThreadSyncSleep

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

Formats the value using the given formatter.

impl Hash for ThreadSyncSleep

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ThreadSyncSleep

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

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

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

impl Eq for ThreadSyncSleep

impl StructuralPartialEq for ThreadSyncSleep