Skip to main content

Timeout

Struct Timeout 

Source
pub struct Timeout { /* private fields */ }
Expand description

The poll budget a blocking wait may spend before giving up.

Each wait creates a fresh Deadline with start, so the budget bounds one wait step (one byte, one FIFO slot, one idle flag), not the whole transaction.

Implementations§

Source§

impl Timeout

Source

pub const DEFAULT: Self

The budget drivers use unless configured otherwise: ten million polls.

Source

pub const fn polls(polls: u32) -> Self

A budget of polls status reads. Zero expires on the first tick.

Source

pub const fn count(self) -> u32

The configured poll count.

Source

pub const fn start(self) -> Deadline

Begin one bounded wait.

Source

pub fn spin<T>(self, ready: impl FnMut() -> Option<T>) -> Result<T, TimedOut>

Poll ready until it yields a value or the budget runs out.

ready runs at least once, so a condition that already holds succeeds even with a zero budget.

Trait Implementations§

Source§

impl Clone for Timeout

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Timeout

Source§

impl Debug for Timeout

Source§

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

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

impl Default for Timeout

Source§

fn default() -> Self

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

impl Eq for Timeout

Source§

impl PartialEq for Timeout

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Timeout

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.