Struct TimerDequeTicketIssuer 

pub struct TimerDequeTicketIssuer<MODE>
where
    MODE: OrderedTimerDequeMode,
{ /* private fields */ }

A type of deque which issues a tickets TimerDequeTicket which contains a TimerDequeId - a uniq number of the ticket. On timeout, the TimerDequeId is returned to indentify the timeout source.

Generics

MODE - a OrderedTimerDequeMode defines the deque behaviour. There are two types of the operation:

• After timeout the element is removed from the queue.

• After timeout the element timeout is extended automatically until the item removed from the queue manually.

Examples

let mut time_list = 
    OrderedTimerDeque
        ::<DequeOnce, TimerDequeTicketIssuer<_>>
        ::new("test_label1".into(), 4, false, true)
           .unwrap();

or

let mut time_list = 
    OrderedTimerDeque
        ::<DequePeriodic, TimerDequeTicketIssuer<_>>
        ::new("test_label1".into(), 4, false, true)
           .unwrap();

Trait Implementations

impl<MODE> Debug for TimerDequeTicketIssuer<MODE>

where MODE: OrderedTimerDequeMode + Debug,

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

Formats the value using the given formatter.

impl<MODE: OrderedTimerDequeMode> Display for TimerDequeTicketIssuer<MODE>

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

Formats the value using the given formatter.

impl<MODE: OrderedTimerDequeMode> Ord for TimerDequeTicketIssuer<MODE>

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<MODE> OrderedTimerDequeHandle<MODE> for TimerDequeTicketIssuer<MODE>

where MODE: OrderedTimerDequeMode,

type TimerId = TimerDequeId

Input item.

type HandleRes = Vec<<TimerDequeTicketIssuer<MODE> as OrderedTimerDequeHandle<MODE>>::TimerId>

A collection which is used to collect the items which are removed from the queue due to timeout.

fn handle( self, timer_self: &mut OrderTimerDeque<MODE, Self>, timer_ids: &mut Self::HandleRes, ) -> TimerResult<()>

A spefic code which is called during timeout routine handling. Normally is should store the result into the collection and reschedule the item if it is repeated.

fn is_same(&self, other: &Self::TimerId) -> bool

Matches the current instance with provided other instances OrderedTimerDequeHandle::TimerId. But, the PartialEq<Self::TimerId> is implemented, so the == can be used to compare.

fn postpone(&mut self, postp_time: RelativeTime) -> TimerResult<()>

Postpones the timeout of the current instance. The postp_time is a RelativeTime i.e inroduces the offset.

fn resched(&mut self, time: MODE) -> TimerResult<()>

Reschedules the current instance. This is different from the postpone as the instance is assagned with a new time. The MODE cannot be changed, only time.

fn into_timer_id(self) -> Option<Self::TimerId>

Attempts to acquire the OrderedTimerDequeHandle::TimerId by consuming the instance.

impl<MODE> OrderedTimerDequeInterf<MODE> for TimerDequeTicketIssuer<MODE>

where MODE: OrderedTimerDequeMode,

fn get_timeout_absolute(&self) -> AbsoluteTime

Returns the absolute time and the timer mode.

impl<MODE: OrderedTimerDequeMode> PartialEq<TimerDequeId> for TimerDequeTicketIssuer<MODE>

fn eq(&self, other: &TimerDequeId) -> 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<MODE: OrderedTimerDequeMode> PartialEq<TimerDequeTicket> for TimerDequeTicketIssuer<MODE>

fn eq(&self, other: &TimerDequeTicket) -> 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<MODE: OrderedTimerDequeMode> PartialEq<TimerDequeTicketIssuer<MODE>> for TimerDequeTicket

fn eq(&self, other: &TimerDequeTicketIssuer<MODE>) -> 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<MODE: OrderedTimerDequeMode> PartialEq for TimerDequeTicketIssuer<MODE>

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<MODE: OrderedTimerDequeMode> PartialOrd for TimerDequeTicketIssuer<MODE>

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<MODE: OrderedTimerDequeMode> Eq for TimerDequeTicketIssuer<MODE>