Struct Canceller

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

An object that allows cancelling the associated Timer.

Implementations§

Source§

impl Canceller

Source

pub fn cancel(&self) -> Result<()>

Cancel the associated Timer.

Examples found in repository?
examples/example2.rs (line 23)
5fn main() {
6    let callback = |status: io::Result<()>| match status {
7        Ok(_) => println!("Called"),
8        Err(ref e) if e.kind() == io::ErrorKind::Interrupted => println!("Cancelled"),
9        Err(e) => eprintln!("Error: {:?}", e),
10    };
11
12    println!("Run callback after 2s");
13    Timer::after(Duration::from_secs(2), callback).unwrap();
14
15    println!("Wait 4s");
16    std::thread::sleep(Duration::from_secs(4));
17
18    println!("Run callback after 4s");
19    let canceller = Timer::after(Duration::from_secs(4), callback).unwrap();
20
21    std::thread::sleep(Duration::from_secs(2));
22    println!("Cancel timer.");
23    canceller.cancel().unwrap();
24
25    std::thread::sleep(Duration::from_secs(3));
26}
More examples
Hide additional examples
examples/example1.rs (line 13)
5fn main() {
6    let (mut timer, canceller) = Timer::new2().unwrap();
7
8    println!("Wait 2s, uninterrupted.");
9    let r = timer.sleep(Duration::from_secs(2));
10    println!("Done: {:?}", r);
11
12    println!("Wait 2s, cancelled at once.");
13    canceller.cancel().unwrap();
14    let r = timer.sleep(Duration::from_secs(2));
15    println!("Done {:?}", r);
16
17    println!("Wait 2s, not cancelled.");
18    let r = timer.sleep(Duration::from_secs(2));
19    println!("Done {:?}", r);
20
21    println!("Wait 10s, cancel after 2s");
22    let canceller2 = canceller.clone();
23    std::thread::spawn(move || {
24        std::thread::sleep(Duration::from_secs(2));
25        canceller2.cancel().unwrap();
26    });
27    match timer.sleep(Duration::from_secs(10)) {
28        Err(ref e) if e.kind() == io::ErrorKind::Interrupted => println!("Cancelled"),
29        x => panic!("{:?}", x),
30    };
31}

Trait Implementations§

Source§

impl Clone for Canceller

Source§

fn clone(&self) -> Canceller

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

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, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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.