## OnceLatch

# Struct OnceLatch

Source

    pub(crate) struct OnceLatch {
        core_latch: CoreLatch,
    }

Expand description

Once latches are used to implement one-time blocking, primarily for the termination flag of the threads in the pool.

Note: like a `SpinLatch`, once-latches are always associated with some registry that is probing them, which must be tickled when they are set. Unlike a `SpinLatch`, they don’t themselves hold a reference to that registry. This is because in some cases the registry owns the once-latch, and that would create a cycle. So a `OnceLatch` must be given a reference to its owning registry when it is set. For this reason, it does not implement the `Latch` trait (but it doesn’t have to, as it is not used in those generic contexts).

## Fields§

§`core_latch: CoreLatch`

## Implementations§

Source§

### impl OnceLatch

Source

#### pub(crate) fn new() -> OnceLatch

Source

#### pub(crate) unsafe fn set_and_tickle_one( this: *const Self, registry: &Registry, target_worker_index: usize, )

Set the latch, then tickle the specific worker thread, which should be the one that owns this latch.

## Trait Implementations§

Source§

### impl AsCoreLatch for OnceLatch

Source§

#### fn as_core_latch(&self) -> &CoreLatch

Source§

### impl Debug for OnceLatch

Source§

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

Formats the value using the given formatter. Read more

## Auto Trait Implementations§

§

### impl !Freeze for OnceLatch

§

### impl RefUnwindSafe for OnceLatch

§

### impl Send for OnceLatch

§

### impl Sync for OnceLatch

§

### impl Unpin for OnceLatch

§

### impl UnwindSafe for OnceLatch

## 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.

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.

Source§

### impl<T> Pointable for T

Source§

#### const ALIGN: usize

The alignment of pointer.
Source§

#### type Init = T

The type for initializers.
Source§

#### unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

#### unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

#### unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

#### unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

#### 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>,

Source§

#### 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.

## 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: 8 bytes