IdleState in rustc_thread_pool::sleep - Rust
Description: An instance of this struct is created when a thread becomes idle. It is consumed when the thread finds work, and passed by `&mut` reference for operations that preserve the idle state. (In other words, producing one of these structs is evidence the thread is idle.) It tracks state such as how long the thread has been idle.

Skip to main content

## IdleState

# Struct IdleState

Source

    pub(crate) struct IdleState {
        worker_index: usize,
        rounds: u32,
        jobs_counter: JobsEventCounter,
    }

Expand description

An instance of this struct is created when a thread becomes idle. It is consumed when the thread finds work, and passed by `&mut` reference for operations that preserve the idle state. (In other words, producing one of these structs is evidence the thread is idle.) It tracks state such as how long the thread has been idle.

## Fields§

§`worker_index: usize`

What is worker index of the idle thread?

§`rounds: u32`

How many rounds have we been circling without sleeping?

§`jobs_counter: JobsEventCounter`

Once we become sleepy, what was the sleepy counter value? Set to `INVALID_SLEEPY_COUNTER` otherwise.

## Implementations§

Source§

### impl IdleState

Source

#### fn wake_fully(&mut self)

Source

#### fn wake_partly(&mut self)

## Auto Trait Implementations§

§

### impl Freeze for IdleState

§

### impl RefUnwindSafe for IdleState

§

### impl Send for IdleState

§

### impl Sync for IdleState

§

### impl Unpin for IdleState

§

### impl UnsafeUnpin for IdleState

§

### impl UnwindSafe for IdleState

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