Skip to main content

Signal

Struct Signal 

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

Cloneable handle onto a scope’s cancellation level. See the module docs for the level/merge model.

The level list is a shared slice, not an owned Vec: clone (the hot per-request/per-record operation) is one atomic increment and zero allocation; only new/child (scope creation) allocate.

Implementations§

Source§

impl Signal

Source

pub fn new() -> Self

Source

pub fn child(&self) -> Self

A nested scope: observes every ancestor level plus a fresh one of its own. Firing the child never touches the ancestors.

Source

pub fn fire(&self)

Fire this handle’s own scope level (idempotent). Ancestor levels are never fired through a child handle.

Source

pub fn is_fired(&self) -> bool

True once this scope or any ancestor scope has fired.

Source

pub fn fired(&self) -> Fired ⓘ

Resolves when this scope or any ancestor fires; resolves immediately if that already happened (sticky level).

Source

pub fn guard(self) -> SignalGuard

Fire-on-drop guard for tying a scope’s lifetime to a value (e.g. cancel a request’s subtree when its driver unwinds).

Trait Implementations§

Source§

impl Clone for Signal

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 Debug for Signal

Source§

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

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

impl Default for Signal

Source§

fn default() -> Self

Returns the “default value” for a type. 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> 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> 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 = !

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.