Struct EventQueue 

pub struct EventQueue<I: Ord, T> { /* private fields */ }

An event queue is an ordered list of events of nonce type I and status type T. Its max capacity is fixed at initialization.

Implementations

impl<I: Ord, T> EventQueue<I, T>

pub fn new(capacity: usize) -> Self

Return an event queue of the given max capacity.

pub fn insert( &mut self, id: EventId<I>, event: T, ) -> Result<(), EventQueueFullError>

where I: Clone,

Insert an event of the given id and status into the queue. Return error if the queue is full. This operation is O(log(n)).

pub fn pop_front<F: Fn(&T) -> bool>( &mut self, matching: F, ) -> Option<(EventId<I>, T)>

where I: Clone,

Remove and return the first matching event. This operation is linear in the events it has to search through.

pub fn purge<F: Fn(&T) -> bool>(&mut self, expiry: u64, matching: F)

where I: Default,

Remove all events of the matching status with an expiry less than the given expiry. This operation is in the number of events matching the expiry condition.

pub fn purge_expired(&mut self, expiry: u64)

where I: Default,

Remove all events with an expiry less than the given expiry. This operation is O(log(n))+O(m), where m is the number of events removed.

pub fn get(&self, id: &EventId<I>) -> Option<&T>

Lookup event status given an event id. This operation is O(log(n)).

pub fn remove(&mut self, id: &EventId<I>) -> Option<T>

Lookup event status given an event id. This operation is O(log(n)).

pub fn modify<F: FnOnce(&mut T)>(&mut self, id: EventId<I>, f: F)

Modify the status of an event given its id. This operation is O(log(n)).

pub fn find(&self, nonce: &I) -> Option<(&EventId<I>, &T)>

Return both an event id and its status if the given nonce is found. This operation is O(log(n)).

pub fn capacity(&self) -> usize

Return max capacity.

pub fn len(&self) -> usize

Return number of events in the queue. This operation is constant time.

pub fn is_full(&self) -> bool

Return true if the queue is at its max capacity. This operation is constant time.

pub fn is_empty(&self) -> bool

Return true if the queue is empty. This operation is constant time.

pub fn iter(&self) -> Box<dyn Iterator<Item = (&EventId<I>, &T)> + '_>

Return an iterator of all events in the order of their EventId, i.e., ordered by expiry first, then by nonce.

Trait Implementations

impl<I: Ord + CandidType, T: CandidType> CandidType for EventQueue<I, T>

fn _ty() -> Type

fn id() -> TypeId

fn idl_serialize<__S>(&self, __serializer: __S) -> Result<(), __S::Error>

where __S: Serializer,

fn ty() -> Type

impl<I: Clone + Ord, T: Clone> Clone for EventQueue<I, T>

fn clone(&self) -> EventQueue<I, T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<I: Debug + Ord, T: Debug> Debug for EventQueue<I, T>

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

Formats the value using the given formatter.

impl<I: Ord, T> Default for EventQueue<I, T>

fn default() -> Self

Return an empty event queue of zero capacity.

impl<'de, I, T> Deserialize<'de> for EventQueue<I, T>

where I: Deserialize<'de> + Ord, T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<I: Hash + Ord, T: Hash> Hash for EventQueue<I, T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<I, T> Serialize for EventQueue<I, T>

where I: Serialize + Ord, T: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.