Struct maitake::sync::spin::Spinlock

pub struct Spinlock { /* private fields */ }
Expand description

A spinlock-based RawMutex implementation.

This mutex will spin with an exponential backoff while waiting for the lock to become available.

This type implements the RawMutex and ScopedRawMutex traits from the [mutex-traits] crate. This allows it to be used with the blocking::Mutex type when a spinlock-based mutex is needed.

Implementations§

§

impl Spinlock

pub const fn new() -> Spinlock

Returns a new Spinlock, in the unlocked state.

Trait Implementations§

§

impl ConstInit for Spinlock

§

const INIT: Spinlock = _

Create a new instance. Read more
§

impl Debug for Spinlock

§

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

Formats the value using the given formatter. Read more
§

impl Default for Spinlock

§

fn default() -> Spinlock

Returns the “default value” for a type. Read more
§

impl RawMutex for Spinlock

§

type GuardMarker = ()

Marker type which determines whether a lock guard should be Send.
§

fn lock(&self)

Acquires this mutex, blocking the current thread/CPU core until it is able to do so.
§

fn try_lock(&self) -> bool

Attempts to acquire this mutex without blocking. Returns true if the lock was successfully acquired and false otherwise.
§

unsafe fn unlock(&self)

Unlocks this mutex. Read more
§

fn is_locked(&self) -> bool

Returns true if the mutex is currently locked.

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<M> ScopedRawMutex for M
where M: RawMutex,

§

fn is_locked(&self) -> bool

Is this mutex currently locked?

§

fn try_with_lock<R>(&self, f: impl FnOnce() -> R) -> Option<R>

Lock this ScopedRawMutex, calling f() after the lock has been acquired, and releasing the lock after the completion of f(). Read more
§

fn with_lock<R>(&self, f: impl FnOnce() -> R) -> R

Lock this ScopedRawMutex, calling f() after the lock has been acquired, and releasing the lock after the completion of f(). Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more