Struct TimerFd 

pub struct TimerFd(/* private fields */);

A common abstract type for the timer which is a main instance.

Implements

This instance implements:

• fmt::Display, [AsRawFd], [AsFd], AsRef, Eq, PartialEq, Deref

• FdTimerMarker, FdTimerRead

• [TimerFdMioCompat] and [mio::event::Source] - if the feature = enable_mio_compat is enabled.

Multithread

A MT-safe, read-only. MT-access is implemented on OS level, so no mutexes or other sync is implemented.

Poll

• A built-in crate::TimerPoll can be used.

• An external crate MIO [TimerFdMioCompat] if feature = enable_mio_compat is enabled.

• User implemented poll. The FD can be aquired via [AsRawFd] [AsFd].

Async

A Future is implemented.

Examples

let timer = 
    TimerFd::new(Cow::Borrowed("test"), TimerType::CLOCK_REALTIME, 
        TimerFlags::empty()).unwrap();
 
timer 

Implementations

impl TimerFd

pub fn new( label: Cow<'static, str>, timer_type: TimerType, timer_flags: TimerFlags, ) -> TimerPortResult<Self>

pub fn get_timer(&self) -> &TimerFdInternal

Borrows non-muntable reference to the timer. A Deref is implemented for this purpose, but the function was left for compat.

Trait Implementations

impl AsFd for TimerFd

fn as_fd(&self) -> BorrowedFd<'_>

Borrows the file descriptor.

impl AsRawFd for TimerFd

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl AsRef<str> for TimerFd

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl AsTimerId for TimerFd

fn as_timer_id(&self) -> TimerId

Returns the uniq timer ID number.

impl Debug for TimerFd

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

Formats the value using the given formatter.

impl Deref for TimerFd

Returns reference to the timer implementation.

type Target = TimerFdInternal

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Display for TimerFd

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

Formats the value using the given formatter.

impl FdTimerMarker for TimerFd

fn clone_timer(&self) -> TimerFd

Clones the instance of the timer.

fn get_strong_count(&self) -> usize

Returns the count of strong references to inner type.

impl FdTimerRead for TimerFd

fn read(&self) -> TimerPortResult<TimerReadRes<u64>>

Attempts to read the timer. The realization is different on different OS. The main purpose is to check if timer is ready (ended).

impl Future for &TimerFd

type Output = Result<TimerReadRes<u64>, TimerPortableErr>

The type of value produced on completion.

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.

impl Future for TimerFd

type Output = Result<TimerReadRes<u64>, TimerPortableErr>

The type of value produced on completion.

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.

impl PartialEq<i32> for TimerFd

fn eq(&self, other: &RawFd) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<str> for TimerFd

fn eq(&self, other: &str) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for TimerFd

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for TimerFd

impl UnixFd for TimerFd

Implementation for the TimrFD.