Struct timerfd::TimerFd

source · [−]

pub struct TimerFd(_);

Expand description

Represents a timerfd.

Implementations

source

impl TimerFd

source

pub fn new_custom(
 clock: ClockId,
 nonblocking: bool,
 cloexec: bool
) -> IoResult<TimerFd>

Creates a new TimerFd.

By default, it uses the monotonic clock, is blocking and does not close on exec. The parameters allow you to change that.

Errors

On Linux 2.6.26 and earlier, nonblocking and cloexec are not supported and setting them will return an error of kind ErrorKind::InvalidInput.

This can also fail in various cases of resource exhaustion. Please check timerfd_create(2) for details.

source

pub fn new() -> IoResult<TimerFd>

Creates a new TimerFd with default settings.

Use new_custom to specify custom settings.

source

pub fn set_state(
    &mut self,
    state: TimerState,
    sflags: SetTimeFlags
) -> TimerState

Sets this timerfd to a given TimerState and returns the old state.

source

pub fn get_state(&self) -> TimerState

Returns the current TimerState.

source

pub fn read(&self) -> u64

Read from this timerfd.

Returns the number of timer expirations since the last read. If this timerfd is operating in blocking mode (the default), it will not return zero but instead block until the timer has expired at least once.

Trait Implementations

source

impl AsRawFd for TimerFd

source

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor. Read more

source

impl FromRawFd for TimerFd

source

unsafe fn from_raw_fd(fd: RawFd) -> Self

Constructs a new instance of Self from the given raw file descriptor. Read more

Auto Trait Implementations

impl RefUnwindSafe for TimerFd

impl Send for TimerFd

impl Sync for TimerFd

impl Unpin for TimerFd

impl UnwindSafe for TimerFd

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> AsRawFilelike for T where
T: AsRawFd,

fn as_raw_filelike(&self) -> i32

Returns the raw value.

impl<T> AsRawSocketlike for T where
T: AsRawFd,

fn as_raw_socketlike(&self) -> i32

Returns the raw value.

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FromRawFilelike for T where
T: FromRawFd,

unsafe fn from_raw_filelike(raw: i32) -> T

Constructs Self from the raw value. Read more

impl<T> FromRawSocketlike for T where
T: FromRawFd,

unsafe fn from_raw_socketlike(raw: i32) -> T

Constructs Self from the raw value. Read more

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct timerfd::TimerFd

Implementations

impl TimerFd

pub fn new_custom( clock: ClockId, nonblocking: bool, cloexec: bool) -> IoResult<TimerFd>

Errors

pub fn new() -> IoResult<TimerFd>

pub fn set_state( &mut self, state: TimerState, sflags: SetTimeFlags) -> TimerState

pub fn get_state(&self) -> TimerState

pub fn read(&self) -> u64

Trait Implementations

impl AsRawFd for TimerFd

fn as_raw_fd(&self) -> RawFd

impl FromRawFd for TimerFd

unsafe fn from_raw_fd(fd: RawFd) -> Self

Auto Trait Implementations

impl RefUnwindSafe for TimerFd

impl Send for TimerFd

impl Sync for TimerFd

impl Unpin for TimerFd

impl UnwindSafe for TimerFd

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> AsRawFilelike for T where T: AsRawFd,

fn as_raw_filelike(&self) -> i32

impl<T> AsRawSocketlike for T where T: AsRawFd,

fn as_raw_socketlike(&self) -> i32

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> FromRawFilelike for T where T: FromRawFd,

unsafe fn from_raw_filelike(raw: i32) -> T

impl<T> FromRawSocketlike for T where T: FromRawFd,

unsafe fn from_raw_socketlike(raw: i32) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

pub fn new_custom(
clock: ClockId,
nonblocking: bool,
cloexec: bool
) -> IoResult<TimerFd>

pub fn set_state(
&mut self,
state: TimerState,
sflags: SetTimeFlags
) -> TimerState

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> AsRawFilelike for T where
T: AsRawFd,

impl<T> AsRawSocketlike for T where
T: AsRawFd,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T> FromRawFilelike for T where
T: FromRawFd,

impl<T> FromRawSocketlike for T where
T: FromRawFd,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,