Struct TimerFdInternal 

pub struct TimerFdInternal { /* 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.

It can be used with provided poll.rs event notification system wrapper.

Trait Implementations

impl AsFd for TimerFdInternal

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

Borrows the file descriptor.

impl AsRawFd for TimerFdInternal

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl AsRef<str> for TimerFdInternal

fn as_ref(&self) -> &str

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

impl Debug for TimerFdInternal

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

Formats the value using the given formatter.

impl Display for TimerFdInternal

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

Formats the value using the given formatter.

impl FdTimerCom for TimerFdInternal

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

Creates new isntance of the timer.

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

Sets the timer. The timer starts immidiatly and working depending on the timer_exp mode.

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

Unsets the timer. The timer stops immidiatly.

fn set_nonblocking(&self, flag: bool) -> TimerPortResult<()>

Sets the timer to non-blocking (on case if flag is true). If the timer was inited with TimerFlags::TFD_NONBLOCK, then this will not do anything.

fn is_nonblocking(&self) -> TimerPortResult<bool>

Reads the FD’s flags and check if Fd is in non-blocking mode. May return error.

impl FdTimerRead for TimerFdInternal

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 &TimerFdInternal

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 TimerFdInternal

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 TimerFdInternal

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 TimerFdInternal

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 TimerFdInternal

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 TimerFdInternal

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 TimerFdInternal

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 TimerFdInternal