Source code
Revision control
Copy as Markdown
Other Tools
use crate::{backend, io};
use core::fmt;
pub use crate::timespec::Timespec;
#[cfg(not(any(
apple,
target_os = "dragonfly",
target_os = "espidf",
target_os = "freebsd", // FreeBSD 12 has clock_nanosleep, but libc targets FreeBSD 11.
target_os = "openbsd",
target_os = "redox",
target_os = "vita",
target_os = "wasi",
)))]
pub use crate::clockid::ClockId;
/// `clock_nanosleep(id, 0, request, remain)`—Sleeps for a duration on a
/// given clock.
///
/// This is `clock_nanosleep` specialized for the case of a relative sleep
/// interval. See [`clock_nanosleep_absolute`] for absolute intervals.
///
/// # References
/// - [POSIX]
/// - [Linux]
///
#[cfg(not(any(
apple,
target_os = "dragonfly",
target_os = "emscripten",
target_os = "espidf",
target_os = "freebsd", // FreeBSD 12 has clock_nanosleep, but libc targets FreeBSD 11.
target_os = "haiku",
target_os = "openbsd",
target_os = "redox",
target_os = "vita",
target_os = "wasi",
)))]
#[inline]
pub fn clock_nanosleep_relative(id: ClockId, request: &Timespec) -> NanosleepRelativeResult {
backend::thread::syscalls::clock_nanosleep_relative(id, request)
}
/// `clock_nanosleep(id, TIMER_ABSTIME, request, NULL)`—Sleeps until an
/// absolute time on a given clock.
///
/// This is `clock_nanosleep` specialized for the case of an absolute sleep
/// interval. See [`clock_nanosleep_relative`] for relative intervals.
///
/// # References
/// - [POSIX]
/// - [Linux]
///
#[cfg(not(any(
apple,
target_os = "dragonfly",
target_os = "emscripten",
target_os = "espidf",
target_os = "freebsd", // FreeBSD 12 has clock_nanosleep, but libc targets FreeBSD 11.
target_os = "haiku",
target_os = "openbsd",
target_os = "redox",
target_os = "vita",
target_os = "wasi",
)))]
#[inline]
pub fn clock_nanosleep_absolute(id: ClockId, request: &Timespec) -> io::Result<()> {
backend::thread::syscalls::clock_nanosleep_absolute(id, request)
}
/// `nanosleep(request, remain)`—Sleeps for a duration.
///
/// This effectively uses the system monotonic clock.
///
/// # References
/// - [POSIX]
/// - [Linux]
///
#[inline]
pub fn nanosleep(request: &Timespec) -> NanosleepRelativeResult {
backend::thread::syscalls::nanosleep(request)
}
/// A return type for `nanosleep` and `clock_nanosleep_relative`.
#[derive(Clone)]
#[must_use]
pub enum NanosleepRelativeResult {
/// The sleep completed normally.
Ok,
/// The sleep was interrupted, the remaining time is returned.
Interrupted(Timespec),
/// An invalid time value was provided.
Err(io::Errno),
}
impl fmt::Debug for NanosleepRelativeResult {
fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
NanosleepRelativeResult::Ok => fmt.write_str("Ok"),
NanosleepRelativeResult::Interrupted(remaining) => write!(
fmt,
"Interrupted(Timespec {{ tv_sec: {:?}, tv_nsec: {:?} }})",
remaining.tv_sec, remaining.tv_nsec
),
NanosleepRelativeResult::Err(err) => write!(fmt, "Err({:?})", err),
}
}
}