Struct Budget 

pub struct Budget { /* private fields */ }

The deadline of one attempt (or one exchange), by Tokio’s monotonic clock, fixed at dispatch.

Implementations

impl Budget

pub fn start(remaining: DurationMs) -> Self

The budget of an attempt dispatched now with remaining left.

pub fn from_ms(ms: u64) -> Self

pub fn deadline(&self) -> Instant

pub fn min(self, other: Budget) -> Budget

The earlier of two budgets.

pub fn remaining(&self) -> Duration

pub fn remaining_ms(&self) -> u64

Whole milliseconds left, rounded down.

pub fn expired(&self) -> bool

pub fn told_ms(&self, transit_margin_ms: u64) -> u64

What the remote side is told: the time left minus the transit margin. Zero means there is no time to give it, and nothing should be sent.

pub fn phase_deadline(&self, limit: Option<Duration>) -> Instant

The deadline of a phase: the budget’s, or limit from now when that is earlier. A phase limit never extends the budget.

pub async fn run<F: Future>( &self, limit: Option<Duration>, fut: F, ) -> Result<F::Output, Expired>

Run fut until it finishes, the budget runs out, or limit (if any) passes, whichever is first.

pub async fn expiry(&self)

Resolves when the budget runs out.

Trait Implementations

impl Clone for Budget

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Budget

impl Debug for Budget

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

Formats the value using the given formatter.

impl Eq for Budget

impl PartialEq for Budget

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Budget