9 stable releases

Uses old Rust 2015

1.6.0 Mar 21, 2024
1.5.0 Jun 8, 2023
1.4.1 Mar 30, 2023
1.4.0 Nov 29, 2022
0.2.0 Nov 30, 2016

#87 in Unix APIs

Download history 19457/week @ 2024-01-23 15089/week @ 2024-01-30 21550/week @ 2024-02-06 20583/week @ 2024-02-13 14172/week @ 2024-02-20 13832/week @ 2024-02-27 15036/week @ 2024-03-05 17427/week @ 2024-03-12 20242/week @ 2024-03-19 10905/week @ 2024-03-26 15497/week @ 2024-04-02 10067/week @ 2024-04-09 10151/week @ 2024-04-16 13012/week @ 2024-04-23 9410/week @ 2024-04-30 9157/week @ 2024-05-07

43,752 downloads per month
Used in 29 crates (8 directly)

MIT license

17KB
267 lines

rust-timerfd

A rust interface to the Linux kernel's timerfd API.

Documentation Crates.io


lib.rs:

A rust interface to the Linux kernel's timerfd API.

Example

use timerfd::{TimerFd, TimerState, SetTimeFlags};
use std::time::Duration;

// Create a new timerfd
// (unwrap is actually fine here for most usecases)
let mut tfd = TimerFd::new().unwrap();

// The timer is initially disarmed
assert_eq!(tfd.get_state(), TimerState::Disarmed);

// Set the timer
tfd.set_state(TimerState::Oneshot(Duration::new(1, 0)), SetTimeFlags::Default);

// Observe that the timer is now set
match tfd.get_state() {
    TimerState::Oneshot(d) => println!("Remaining: {:?}", d),
    _ => unreachable!(),
}

// Wait for the remaining time
tfd.read();

// It was a oneshot timer, so it's now disarmed
assert_eq!(tfd.get_state(), TimerState::Disarmed);

Usage

Unfortunately, this example can't show why you would use timerfd in the first place: Because it creates a file descriptor that you can monitor with select(2), poll(2) and epoll(2).

In other words, the primary advantage this offers over any other timer implementation is that it implements the AsFd/AsRawFd traits.

The file descriptor becomes ready/readable whenever the timer expires.

Dependencies

~1–10MB
~107K SLoC