Skip to main content

CancelGroup

Struct CancelGroup 

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

OR-combinator for cancellation tokens.

Fires when any source token is cancelled. No spawn — uses sync polling for is_cancelled() and select_all for the async cancelled() future.

Supports composition via |:

let cancel = token_a | token_b;
let cancel = group | extra_token;
let cancel = group1 | group2;

Implementations§

Source§

impl CancelGroup

Source

pub fn new(sources: Vec<CancellationToken>) -> Self

Source

pub async fn cancelled(&self)

Source

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

Returns true if both groups share the same underlying source array.

Source

pub fn is_cancelled(&self) -> bool

Trait Implementations§

Source§

impl BitOr<CancelGroup> for CancellationToken

Source§

type Output = CancelGroup

The resulting type after applying the | operator.
Source§

fn bitor(self, rhs: CancelGroup) -> CancelGroup

Performs the | operation. Read more
Source§

impl BitOr<CancellationToken> for CancelGroup

Source§

type Output = CancelGroup

The resulting type after applying the | operator.
Source§

fn bitor(self, rhs: CancellationToken) -> Self

Performs the | operation. Read more
Source§

impl BitOr for CancelGroup

Source§

type Output = CancelGroup

The resulting type after applying the | operator.
Source§

fn bitor(self, rhs: Self) -> Self

Performs the | operation. Read more
Source§

impl Clone for CancelGroup

Source§

fn clone(&self) -> CancelGroup

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 From<CancellationToken> for CancelGroup

Source§

fn from(token: CancellationToken) -> Self

Converts to this type from the input type.
Source§

impl From<Vec<CancellationToken>> for CancelGroup

Source§

fn from(tokens: Vec<CancellationToken>) -> Self

Converts to this type from the input type.

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 = 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> MaybeSend for T
where T: Send,

Source§

impl<T> MaybeSync for T
where T: Sync,