[go: up one dir, main page]

rustix 1.1.0

Safe Rust bindings to POSIX/Unix/Linux/Winsock-like syscalls
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77

use crate::fd::{AsFd, OwnedFd};
use crate::timespec::Timespec;
use crate::{backend, io};

pub use backend::time::types::{TimerfdClockId, TimerfdFlags, TimerfdTimerFlags};

/// `struct itimerspec` for use with [`timerfd_gettime`] and
/// [`timerfd_settime`].
///
/// [`timerfd_gettime`]: crate::time::timerfd_gettime
/// [`timerfd_settime`]: crate::time::timerfd_settime
#[derive(Debug, Clone)]
pub struct Itimerspec {
    /// Interval between times.
    pub it_interval: Timespec,
    /// Value of the time.
    pub it_value: Timespec,
}

/// `timerfd_create(clockid, flags)`—Create a timer.
///
/// For a higher-level API to timerfd functionality, see the [timerfd] crate.
///
/// [timerfd]: https://crates.io/crates/timerfd
///
/// # References
///  - [Linux]
///  - [FreeBSD]
///  - [illumos]
///  - [NetBSD]
///
/// [Linux]: https://man7.org/linux/man-pages/man2/timerfd_create.2.html
/// [FreeBSD]: https://man.freebsd.org/cgi/man.cgi?query=timerfd_create&sektion=2
/// [illumos]: https://illumos.org/man/3C/timerfd_create
/// [NetBSD]: https://man.netbsd.org/timerfd_create.2
#[inline]
pub fn timerfd_create(clockid: TimerfdClockId, flags: TimerfdFlags) -> io::Result<OwnedFd> {
    backend::time::syscalls::timerfd_create(clockid, flags)
}

/// `timerfd_settime(clockid, flags, new_value)`—Set the time on a timer.
///
/// # References
///  - [Linux]
///  - [FreeBSD]
///  - [illumos]
///  - [NetBSD]
///
/// [Linux]: https://man7.org/linux/man-pages/man2/timerfd_settime.2.html
/// [FreeBSD]: https://man.freebsd.org/cgi/man.cgi?query=timerfd_settime&sektion=2
/// [illumos]: https://illumos.org/man/3C/timerfd_settime
/// [NetBSD]: https://man.netbsd.org/timerfd_settime.2
#[inline]
pub fn timerfd_settime<Fd: AsFd>(
    fd: Fd,
    flags: TimerfdTimerFlags,
    new_value: &Itimerspec,
) -> io::Result<Itimerspec> {
    backend::time::syscalls::timerfd_settime(fd.as_fd(), flags, new_value)
}

/// `timerfd_gettime(clockid, flags)`—Query a timer.
///
/// # References
///  - [Linux]
///  - [FreeBSD]
///  - [illumos]
///  - [NetBSD]
///
/// [Linux]: https://man7.org/linux/man-pages/man2/timerfd_gettime.2.html
/// [FreeBSD]: https://man.freebsd.org/cgi/man.cgi?query=timerfd_gettime&sektion=2
/// [illumos]: https://illumos.org/man/3C/timerfd_gettime
/// [NetBSD]: https://man.netbsd.org/timerfd_gettime.2
#[inline]
pub fn timerfd_gettime<Fd: AsFd>(fd: Fd) -> io::Result<Itimerspec> {
    backend::time::syscalls::timerfd_gettime(fd.as_fd())
}