OrStop

Struct OrStop 

Source
pub struct OrStop<A, B> { /* private fields */ }
Expand description

Combines two Stop implementations.

The combined stop will trigger when either source stops.

§Example

use almost_enough::{StopSource, OrStop, Stop};

let timeout_source = StopSource::new();
let cancel_source = StopSource::new();

let combined = OrStop::new(timeout_source.as_ref(), cancel_source.as_ref());

// Not stopped yet
assert!(!combined.should_stop());

// Either source can trigger stop
cancel_source.cancel();
assert!(combined.should_stop());

Implementations§

Source§

impl<A, B> OrStop<A, B>

Source

pub fn new(a: A, b: B) -> Self

Create a new combined stop that triggers when either source stops.

Source

pub fn first(&self) -> &A

Get a reference to the first stop source.

Source

pub fn second(&self) -> &B

Get a reference to the second stop source.

Source

pub fn into_inner(self) -> (A, B)

Decompose into the two inner stop sources.

Trait Implementations§

Source§

impl<A: Clone, B: Clone> Clone for OrStop<A, B>

Source§

fn clone(&self) -> OrStop<A, B>

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<A: Debug, B: Debug> Debug for OrStop<A, B>

Source§

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

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

impl<A: Stop, B: Stop> Stop for OrStop<A, B>

Source§

fn check(&self) -> Result<(), StopReason>

Check if the operation should stop. Read more
Source§

fn should_stop(&self) -> bool

Returns true if the operation should stop. Read more
Source§

impl<A: Copy, B: Copy> Copy for OrStop<A, B>

Auto Trait Implementations§

§

impl<A, B> Freeze for OrStop<A, B>
where A: Freeze, B: Freeze,

§

impl<A, B> RefUnwindSafe for OrStop<A, B>

§

impl<A, B> Send for OrStop<A, B>
where A: Send, B: Send,

§

impl<A, B> Sync for OrStop<A, B>
where A: Sync, B: Sync,

§

impl<A, B> Unpin for OrStop<A, B>
where A: Unpin, B: Unpin,

§

impl<A, B> UnwindSafe for OrStop<A, B>
where A: UnwindSafe, B: UnwindSafe,

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> StopExt for T
where T: Stop,

Source§

fn or<S: Stop>(self, other: S) -> OrStop<Self, S>

Combine this stop with another, stopping if either stops. Read more
Source§

fn into_boxed(self) -> BoxedStop
where Self: 'static,

Convert this stop into a boxed trait object. Read more
Source§

fn child(&self) -> ChildStopper
where Self: Clone + 'static,

Create a child stop that inherits cancellation from this stop. Read more
Source§

impl<T> TimeoutExt for T
where T: Stop,

Source§

fn with_timeout(self, duration: Duration) -> WithTimeout<Self>

Add a timeout to this stop. Read more
Source§

fn with_deadline(self, deadline: Instant) -> WithTimeout<Self>

Add an absolute deadline to this stop. Read more
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.