Struct windows_win::TimerBuilder

pub struct TimerBuilder<'a> { /* fields omitted */ }

WinAPI timer builder

The same timer can act as one-shot timer and/or interval timer.

Configuration

When single method is called timer is configured as one-shot.

When interval method is called timer is configured as interval.

When both of the above are called timer is configured as one-shot, after which it starts to run in interval.

By default timer starts as one-shot with timeout 0.

Methods

impl<'a> TimerBuilder<'a>

pub fn new() -> Self

Creates new instance

pub fn raw_callback(self, cb: CallbackType, param: Option<*mut c_void>) -> Self

Sets raw C function as callback

pub fn rust_callback(self, cb: fn()) -> Self

Sets Rust function pointer as callback

pub fn queue(self, queue: &'a TimerQueue) -> Self

Sets timer queue.

If not set, default shall be used.

pub fn single(self, delay: c_ulong) -> Self

Makes timer to fire single time after delay in milliseconds.

pub fn interval(self, interval: c_ulong) -> Self

Makes timer to fire with interval in milliseconds.

pub fn flags(self, flags: TimerFlags) -> Self

Specifies timer flags.

Default is raw::timer::DEFAULT_TIMER_FLAGS.

pub fn build(self) -> Result<QueueTimer>

Creates timer.