Struct PolledTimerFd 

pub struct PolledTimerFd<T: FdTimerMarker> { /* private fields */ }

A wrapper which provides a funtionality for the TimerPoll.

A TimerFd should be wrapped into this instance and a poll instance is attached during wrapping.

By calling drop, the timer is automatically removed from the poller and timer will be destructed too. The same situation happens if [SyncTimerFd::detach_timer] is called, but the timer instance is returned.

Implementations

impl<T: FdTimerMarker> PolledTimerFd<T>

pub fn detach_timer(self) -> Result<T, Self>

Removes the timer from the poll instance and releases the timer instance.

In case, if it is not possible to relese the timer, the Result::Err is returnes with Self. Otherwise, a T is returned.

pub fn is_poll_valid(&self) -> bool

Checks if poll instance still presents. It can not verify if poll operates normally. Just checks if current instance is attached to the instance which is valid.

pub fn get_inner(&self) -> &T

Returns the reference to the inner timer.

pub fn get_inner_mut(&mut self) -> &mut T

Trait Implementations

impl<T: FdTimerMarker> AsRef<str> for PolledTimerFd<T>

fn as_ref(&self) -> &str

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

impl<T: Debug + FdTimerMarker> Debug for PolledTimerFd<T>

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

Formats the value using the given formatter.

impl<T: FdTimerMarker> Display for PolledTimerFd<T>

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

Formats the value using the given formatter.

impl<T: FdTimerMarker> Drop for PolledTimerFd<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: FdTimerMarker> Ord for PolledTimerFd<T>

Available on target_family=unix only.

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<T: FdTimerMarker> PartialEq<str> for PolledTimerFd<T>

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<T: FdTimerMarker> PartialEq for PolledTimerFd<T>

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<T: FdTimerMarker> PartialOrd for PolledTimerFd<T>

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<T: FdTimerMarker> Eq for PolledTimerFd<T>