Struct TimerFd 

pub struct TimerFd { /* private fields */ }

A synchronious timer instance based on the Linux’s timerfd_create.

A EPoll or select can be used to monitor the instance. Also the instance implements Future which can be polled from async code. Or used with tokio’s AsyncFd or any other equivalent.

Implementations

impl TimerFd

pub fn set_nonblocking(&self) -> TimerPortResult<()>

Sets the timer to nonblocking mode for read operation. If the timer was inited with TimerFlags::TFD_NONBLOCK, then this will not do anything.

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 AsTimerFd for TimerFd

fn get_bind(&self) -> Option<Arc<DefaultEventWatch>>

Should return the upgraded reference to which instance it is bind.

fn bind_poll(&self, timer_weak_ref: Weak<DefaultEventWatch>)

Regesters poller DefaultEventWatch on the timer’s record.

fn unbind_poll(&self)

Removes bind fromt the timer.

impl Debug for TimerFd

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

Formats the value using the given formatter.

impl Display for TimerFd

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

Formats the value using the given formatter.

impl Drop for TimerFd

fn drop(&mut self)

Executes the destructor for this type.

impl FdTimerCom for TimerFd

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

Reads the FD.

Returns

• If FD is configured as non-blocking then returns TimerReadRes::WouldBlock otherwise would block.

• If daytime modification happened the TimerReadRes::Cancelled will be returned, however it depends if the [TimerSetTimeFlags::TFD_TIMER_CANCEL_ON_SET] is set with [TimerSetTimeFlags::TFD_TIMER_ABSTIME].

• If read was successfull the amount of the overflows before read will be returned i.e TimerReadRes::Ok. Normally is is 1. If 0 is returned then probably the time or day was modified.

• The Result::Err is returned if other error occured.

fn set_time<TIMERTYPE: ModeTimeType>( &self, timer_exp: TimerExpMode<TIMERTYPE>, ) -> TimerPortResult<()>

Sets the timer with the specific flags and time experation mode.

The timer_exp time must be in future if [TimerSetTimeFlags::TFD_TIMER_ABSTIME] was selected.

Arguments

• flags - [TimerSetTimeFlags] flags.

• timer_exp - TimerExpMode a timer mode.

Returns

The Result::Err is returned if other error occured.

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

Creates new isntance of the timer.

fn unset_time(&self) -> TimerPortResult<()>

Unsets the timer. The timer stops immidiatly.

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 Ord for TimerFd

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

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 PartialOrd for TimerFd

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for TimerFd