pub struct CancelToken { /* private fields */ }Expand description
Cooperative cancellation handle shared across threads (Clone shares the same flag).
Implementations§
Source§impl CancelToken
impl CancelToken
Sourcepub fn never() -> Self
pub fn never() -> Self
Alias for Self::new: a handle that never cancels unless Self::cancel is called.
Sourcepub fn never_ref() -> &'static Self
pub fn never_ref() -> &'static Self
Shared uncancelled handle for default &Self parameters (see Self::never for an owned clone).
Sourcepub fn reset(&self)
pub fn reset(&self)
Clears a prior cancellation (for example when reinstalling signal handlers).
Sourcepub fn is_cancelled(&self) -> bool
pub fn is_cancelled(&self) -> bool
Returns true once Self::cancel was called or a test countdown reached zero.
Sourcepub fn poll_before_wait(&self)
pub fn poll_before_wait(&self)
Poll hook before blocking waits (in tests, counts toward the poll budget from
CancelToken::after_polls).
Trait Implementations§
Source§impl Clone for CancelToken
impl Clone for CancelToken
Source§impl Debug for CancelToken
impl Debug for CancelToken
Auto Trait Implementations§
impl Forget for CancelToken
impl Freeze for CancelToken
impl RefUnwindSafe for CancelToken
impl Send for CancelToken
impl Sync for CancelToken
impl Unpin for CancelToken
impl UnsafeUnpin for CancelToken
impl UnwindSafe for CancelToken
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more