Struct drain::Watch

source · [−]

pub struct Watch { /* private fields */ }

Expand description

Watch for a drain command.

All Watch instances must be dropped for a Signal::signal call to complete.

Implementations

source

impl Watch

source

pub async fn signaled(self) -> ReleaseShutdown

Returns a ReleaseShutdown handle after the drain has been signaled. The handle must be dropped when a shutdown action has been completed to unblock graceful shutdown.

source

pub fn ignore_signaled(self) -> ReleaseShutdown

Return a ReleaseShutdown handle immediately, ignoring the release signal.

This is intended to allow a task to block shutdown until it completes.

source

pub async fn watch<A, F>(self, future: A, on_drain: F) -> A::Output where
A: Future + Unpin,
F: FnOnce(&mut A),

Wrap a future and a callback that is triggered when drain is received.

The callback receives a mutable reference to the original future, and should be used to trigger any shutdown process for it.

Trait Implementations

source

impl Clone for Watch

source

fn clone(&self) -> Watch

Returns a copy 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 Debug for Watch

source

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl !RefUnwindSafe for Watch

impl Send for Watch

impl Sync for Watch

impl Unpin for Watch

impl !UnwindSafe for Watch

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

pub 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,

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

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

source

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct drain::Watch

Implementations

impl Watch

pub async fn signaled(self) -> ReleaseShutdown

pub fn ignore_signaled(self) -> ReleaseShutdown

pub async fn watch<A, F>(self, future: A, on_drain: F) -> A::Output where
A: Future + Unpin,
F: FnOnce(&mut A),

Trait Implementations

impl Clone for Watch

fn clone(&self) -> Watch

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

impl Debug for Watch

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

Auto Trait Implementations

impl !RefUnwindSafe for Watch

impl Send for Watch

impl Sync for Watch

impl Unpin for Watch

impl !UnwindSafe for Watch

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where
T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where
T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where
U: From<T>,

pub fn into(self) -> U

impl<T> ToOwned for T where
T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

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

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Struct drain::Watch

Implementations

impl Watch

pub async fn signaled(self) -> ReleaseShutdown

pub fn ignore_signaled(self) -> ReleaseShutdown

pub async fn watch<A, F>(self, future: A, on_drain: F) -> A::Output where A: Future + Unpin, F: FnOnce(&mut A),

Trait Implementations

impl Clone for Watch

fn clone(&self) -> Watch

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

impl Debug for Watch

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

Auto Trait Implementations

impl !RefUnwindSafe for Watch

impl Send for Watch

impl Sync for Watch

impl Unpin for Watch

impl !UnwindSafe for Watch

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

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

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

pub async fn watch<A, F>(self, future: A, on_drain: F) -> A::Output where
A: Future + Unpin,
F: FnOnce(&mut A),

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,