Timer

Struct Timer 

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

A high-precision future that completes after a specified duration.

Timer provides platform-native timing capabilities that leverage operating system scheduling primitives for accurate delays without busy-waiting. The timer integrates seamlessly with async/await and provides zero-cost abstraction over native OS APIs.

§Platform Behavior

  • Apple platforms: Uses GCD’s dispatch_after for precise scheduling
  • Other platforms: Will use platform-specific high-resolution APIs

§Performance

Unlike thread-based sleep implementations, Timer doesn’t block threads and allows the executor to handle other tasks while waiting.

§Examples

use native_executor::timer::Timer;
use std::time::Duration;

async fn precise_timing() {
    // Millisecond precision timing
    Timer::after(Duration::from_millis(250)).await;
     
    // Second-based convenience method
    Timer::after_secs(2).await;
}

Implementations§

Source§

impl Timer

Source

pub fn after(duration: Duration) -> Self

Creates a new Timer that will complete after the specified duration.

§Arguments
  • duration - The amount of time to wait before the timer completes.
§Returns

A new Timer instance that can be awaited.

§Example
use native_executor::timer::Timer;
use std::time::Duration;

async fn example() {
    // Wait for 1 second
    Timer::after(Duration::from_secs(1)).await;
    println!("One second has passed!");
}
Examples found in repository?
examples/timers.rs (line 13)
7fn main() {
8    spawn(async {
9        println!("Starting timers example");
10
11        // Use the Timer API
12        println!("Waiting for 500ms...");
13        Timer::after(Duration::from_millis(500)).await;
14        println!("500ms elapsed");
15
16        // Use the seconds convenience method
17        println!("Waiting for 1 second...");
18        Timer::after_secs(1).await;
19        println!("1 second elapsed");
20
21        // Use the sleep convenience function
22        println!("Sleeping for 2 seconds...");
23        sleep(2).await;
24        println!("2 seconds elapsed");
25
26        println!("Timers example completed");
27    })
28    .detach();
29
30    // Keep the main thread alive
31    std::thread::sleep(Duration::from_secs(4));
32}
Source

pub fn after_secs(secs: u64) -> Self

Creates a new Timer that will complete after the specified number of seconds.

This is a convenience method that wraps Timer::after with Duration::from_secs.

§Arguments
  • secs - The number of seconds to wait before the timer completes.
§Returns

A new Timer instance that can be awaited.

§Example
use native_executor::timer::Timer;

async fn example() {
    // Wait for 5 seconds
    Timer::after_secs(5).await;
    println!("Five seconds have passed!");
}
Examples found in repository?
examples/simple_task.rs (line 12)
4fn main() {
5    println!("Starting example");
6
7    // Spawn a task with default priority
8    spawn(async {
9        println!("Task started");
10
11        // Wait for 1 second
12        Timer::after_secs(1).await;
13
14        println!("Task completed after 1 second");
15    })
16    .detach();
17
18    // Keep the main thread alive
19    std::thread::sleep(Duration::from_secs(2));
20
21    println!("Example completed");
22}
More examples
Hide additional examples
examples/priority.rs (line 8)
4fn main() {
5    // Spawn a default priority task
6    spawn(async {
7        println!("Default priority task started");
8        Timer::after_secs(1).await;
9        println!("Default priority task completed");
10    })
11    .detach();
12
13    // Spawn a background priority task
14    spawn_with_priority(
15        async {
16            println!("Background priority task started");
17            Timer::after_secs(1).await;
18            println!("Background priority task completed");
19        },
20        Priority::Background,
21    )
22    .detach();
23
24    // Keep the main thread alive
25    std::thread::sleep(Duration::from_secs(2));
26}
examples/timers.rs (line 18)
7fn main() {
8    spawn(async {
9        println!("Starting timers example");
10
11        // Use the Timer API
12        println!("Waiting for 500ms...");
13        Timer::after(Duration::from_millis(500)).await;
14        println!("500ms elapsed");
15
16        // Use the seconds convenience method
17        println!("Waiting for 1 second...");
18        Timer::after_secs(1).await;
19        println!("1 second elapsed");
20
21        // Use the sleep convenience function
22        println!("Sleeping for 2 seconds...");
23        sleep(2).await;
24        println!("2 seconds elapsed");
25
26        println!("Timers example completed");
27    })
28    .detach();
29
30    // Keep the main thread alive
31    std::thread::sleep(Duration::from_secs(4));
32}

Trait Implementations§

Source§

impl Debug for Timer

Source§

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

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

impl Future for Timer

Source§

type Output = ()

The type of value produced on completion.
Source§

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available. Read more

Auto Trait Implementations§

§

impl Freeze for Timer

§

impl RefUnwindSafe for Timer

§

impl Send for Timer

§

impl Sync for Timer

§

impl Unpin for Timer

§

impl UnwindSafe for Timer

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<F> FutureExt for F
where F: Future + ?Sized,

Source§

fn poll(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output>
where Self: Unpin,

A convenience for calling Future::poll() on !Unpin types.
Source§

fn or<F>(self, other: F) -> Or<Self, F>
where Self: Sized, F: Future<Output = Self::Output>,

Returns the result of self or other future, preferring self if both are ready. Read more
Source§

fn race<F>(self, other: F) -> Race<Self, F>
where Self: Sized, F: Future<Output = Self::Output>,

Returns the result of self or other future, with no preference if both are ready. Read more
Source§

fn catch_unwind(self) -> CatchUnwind<Self>
where Self: Sized + UnwindSafe,

Catches panics while polling the future. Read more
Source§

fn boxed<'a>(self) -> Pin<Box<dyn Future<Output = Self::Output> + Send + 'a>>
where Self: Sized + Send + 'a,

Boxes the future and changes its type to dyn Future + Send + 'a. Read more
Source§

fn boxed_local<'a>(self) -> Pin<Box<dyn Future<Output = Self::Output> + 'a>>
where Self: Sized + 'a,

Boxes the future and changes its type to dyn Future + 'a. Read more
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<F> IntoFuture for F
where F: Future,

Source§

type Output = <F as Future>::Output

The output that the future will produce on completion.
Source§

type IntoFuture = F

Which kind of future are we turning this into?
Source§

fn into_future(self) -> <F as IntoFuture>::IntoFuture

Creates a future from a value. 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.