Skip to main content

GracefulTimeoutsBuilder

Struct GracefulTimeoutsBuilder 

Source
pub struct GracefulTimeoutsBuilder<State> { /* private fields */ }
Expand description

Typestate builder for GracefulTimeouts. Created via GracefulTimeouts::builder.

Both unix and windows must be called (in that order) before build becomes available. The setter for the platform that does not match the current target accepts its arguments without using them, so cross-platform code can build a value without cfg gates.

Implementations§

Source§

impl GracefulTimeoutsBuilder<UnixUnset>

Source

pub fn unix( self, timeouts: (Duration, Duration), ) -> GracefulTimeoutsBuilder<UnixSet>

Set the Unix-side budgets as a (interrupt_timeout, terminate_timeout) tuple.

Use both for the common case where both phases share the same value.

On non-Unix targets the tuple is accepted but unused.

Source§

impl GracefulTimeoutsBuilder<UnixSet>

Source

pub fn windows( self, graceful_timeout: Duration, ) -> GracefulTimeoutsBuilder<BothSet>

Set the Windows-side graceful budget.

On non-Windows targets the value is accepted but unused.

Source§

impl GracefulTimeoutsBuilder<BothSet>

Source

pub fn build(self) -> GracefulTimeouts

Finish the builder, producing a GracefulTimeouts populated from the platform-relevant inputs.

Trait Implementations§

Source§

impl<State: Clone> Clone for GracefulTimeoutsBuilder<State>

Source§

fn clone(&self) -> GracefulTimeoutsBuilder<State>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<State: Debug> Debug for GracefulTimeoutsBuilder<State>

Source§

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

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

impl<State: Copy> Copy for GracefulTimeoutsBuilder<State>

Auto Trait Implementations§

§

impl<State> Freeze for GracefulTimeoutsBuilder<State>

§

impl<State> RefUnwindSafe for GracefulTimeoutsBuilder<State>

§

impl<State> Send for GracefulTimeoutsBuilder<State>

§

impl<State> Sync for GracefulTimeoutsBuilder<State>

§

impl<State> Unpin for GracefulTimeoutsBuilder<State>

§

impl<State> UnsafeUnpin for GracefulTimeoutsBuilder<State>

§

impl<State> UnwindSafe for GracefulTimeoutsBuilder<State>

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> Sink for T
where T: Send + 'static,