Struct otter_api_tests::imports::nix::sys::timerfd::TimerFd[−]

pub struct TimerFd { /* fields omitted */ }

Expand description

A timerfd instance. This is also a file descriptor, you can feed it to other interfaces consuming file descriptors, epoll for example.

Implementations

impl TimerFd

pub fn new(clockid: ClockId, flags: TimerFlags) -> Result<TimerFd, Error>

Creates a new timer based on the clock defined by clockid. The underlying fd can be assigned specific flags with flags (CLOEXEC, NONBLOCK). The underlying fd will be closed on drop.

pub fn set(
    &self, 
    expiration: Expiration, 
    flags: TimerSetTimeFlags
) -> Result<(), Error>

Sets a new alarm on the timer.

Types of alarm

There are 3 types of alarms you can set:

one shot: the alarm will trigger once after the specified amount of time. Example: I want an alarm to go off in 60s and then disables itself.
interval: the alarm will trigger every specified interval of time. Example: I want an alarm to go off every 60s. The alarm will first go off 60s after I set it and every 60s after that. The alarm will not disable itself.
interval delayed: the alarm will trigger after a certain amount of time and then trigger at a specified interval. Example: I want an alarm to go off every 60s but only start in 1h. The alarm will first trigger 1h after I set it and then every 60s after that. The alarm will not disable itself.

Relative vs absolute alarm

If you do not set any TimerSetTimeFlags, then the TimeSpec you pass to the Expiration you want is relative. If however you want an alarm to go off at a certain point in time, you can set TFD_TIMER_ABSTIME. Then the one shot TimeSpec and the delay TimeSpec of the delayed interval are going to be interpreted as absolute.

Disabling alarms

Note: Only one alarm can be set for any given timer. Setting a new alarm actually removes the previous one.

Note: Setting a one shot alarm with a 0s TimeSpec disables the alarm altogether.

pub fn get(&self) -> Result<Option<Expiration>, Error>

Get the parameters for the alarm currently set, if any.

pub fn unset(&self) -> Result<(), Error>

Remove the alarm if any is set.

pub fn wait(&self) -> Result<(), Error>

Wait for the configured alarm to expire.

Note: If the alarm is unset, then you will wait forever.

Trait Implementations

impl AsRawFd for TimerFd

pub fn as_raw_fd(&self) -> i32

Extracts the raw file descriptor. Read more

impl Debug for TimerFd

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

Formats the value using the given formatter. Read more

impl Drop for TimerFd

pub fn drop(&mut self)

Executes the destructor for this type. Read more

impl FromRawFd for TimerFd

pub unsafe fn from_raw_fd(fd: i32) -> TimerFd

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

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

[src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

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

[src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

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

[src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> DebugExt<T> for T where
    T: Debug,

pub fn to_debug(&self) -> String

impl<T> Downcast for T where
    T: Any,

pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>ⓘNotable traits for Box<R, Global>
impl<R> Read for Box<R, Global> where
    R: Read + ?Sized, impl<W> Write for Box<W, Global> where
    W: Write + ?Sized, impl<I, A> Iterator for Box<I, A> where
    A: Allocator,
    I: Iterator + ?Sized,     type Item = <I as Iterator>::Item;impl<F, A> Future for Box<F, A> where
    A: Allocator + 'static,
    F: Future + Unpin + ?Sized,     type Output = <F as Future>::Output;

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

pub fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

impl<T> DowncastSync for T where
    T: Any + Send + Sync,

pub fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + 'static + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

impl<A> DynCastExt for A

pub fn dyn_cast<T>(
    self
) -> Result<<A as DynCastExtHelper<T>>::Target, <A as DynCastExtHelper<T>>::Source> where
    T: ?Sized,
    A: DynCastExtHelper<T>,

Use this to cast from one trait object type to another. Read more

pub fn dyn_upcast<T>(self) -> <A as DynCastExtAdvHelper<T, T>>::Target where
    T: ?Sized,
    A: DynCastExtAdvHelper<T, T, Source = <A as DynCastExtAdvHelper<T, T>>::Target>,

Use this to upcast a trait to one of its supertraits. Read more

pub fn dyn_cast_adv<F, T>(
    self
) -> Result<<A as DynCastExtAdvHelper<F, T>>::Target, <A as DynCastExtAdvHelper<F, T>>::Source> where
    T: ?Sized,
    A: DynCastExtAdvHelper<F, T>,
    F: ?Sized,

Use this to cast from one trait object type to another. This method is more customizable than the dyn_cast method. Here you can also specify the “source” trait from which the cast is defined. This can for example allow using casts from a supertrait of the current trait object. Read more

pub fn dyn_cast_with_config<C>(
    self
) -> Result<<A as DynCastExtAdvHelper<<C as DynCastConfig>::Source, <C as DynCastConfig>::Target>>::Target, <A as DynCastExtAdvHelper<<C as DynCastConfig>::Source, <C as DynCastConfig>::Target>>::Source> where
    C: DynCastConfig,
    A: DynCastExtAdvHelper<<C as DynCastConfig>::Source, <C as DynCastConfig>::Target>,

Use this to cast from one trait object type to another. With this method the type parameter is a config type that uniquely specifies which cast should be preformed. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T> Instrument for T[src]

fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>
impl<T> Future for Instrumented<T> where
    T: Future,     type Output = <T as Future>::Output;

[src]

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>
impl<T> Future for Instrumented<T> where
    T: Future,     type Output = <T as Future>::Output;

[src]

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

[src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> Same<T> for T

type Output = T

Should always be Self

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

[src]

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

[src]

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,

pub fn vzip(self) -> V