Skip to main content

QuiesceTimeout

Struct QuiesceTimeout 

Source
pub struct QuiesceTimeout {
    pub remaining_cross_queue: u64,
    pub remaining_outstanding_refs: u64,
    pub elapsed: Duration,
}
Expand description

Returned by Runtime::shutdown_quiesce when the timeout elapses before the executor reaches a quiesced state.

The diagnostic fields help identify which producer didn’t release its refs:

  • remaining_cross_queue: number of cross-thread queue entries still pending at the moment of timeout. Non-zero indicates a producer thread is still pushing wakes faster than quiesce can drain them, OR a final-drain wake landed after the last drain pass — investigate which off-thread producer is still active.
  • remaining_outstanding_refs: number of tasks still in Executor::all_tasks at the moment of timeout. Each represents a task with outstanding cross-thread refs (or a held JoinHandle).
  • elapsed: how long quiesce ran before timing out.

PR 2 §2.4 open-item 5 noted that finer-grained diagnostics (“which task ID had the outstanding ref”) could be added if implementation revealed them as cheap to surface. The implementation uses Executor::task_count() which doesn’t enumerate tasks; adding per-task data here would require new accessors. Out of scope for initial PR 2; future enhancement.

Fields§

§remaining_cross_queue: u64

Number of cross-thread queue entries still pending at timeout. Non-zero means a producer is racing the drain loop.

§remaining_outstanding_refs: u64

Number of tasks still alive at the moment of timeout. Each is a candidate for “producer hasn’t released its refs.”

§elapsed: Duration

Time elapsed inside shutdown_quiesce before returning timeout. Approximately equal to the input timeout.

Trait Implementations§

Source§

impl Debug for QuiesceTimeout

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for QuiesceTimeout

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Error for QuiesceTimeout

1.30.0 · Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type-based access to context intended for error reports. Read more

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.

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.