Struct ReadyBuffer 

pub struct ReadyBuffer<K, T> {
    pub heap: BinaryHeap<ItemWithReadyKey<K, T>>,
}

A buffer that contains items associated with a key (a Tick, Instant, etc.)

Elements in the buffer are popped only when they are ‘ready’, i.e. when the key associated with the item is less than or equal to the current key

The most recent item (by associated key) is returned first

Fields

heap: BinaryHeap<ItemWithReadyKey<K, T>>

min heap: we pop the items with smallest key first

Implementations

impl<K: Ord, T> ReadyBuffer<K, T>

pub fn new() -> Self

impl<K: Ord + Clone, T> ReadyBuffer<K, T>

pub fn push(&mut self, key: K, item: T)

Adds an item to the heap marked by time

pub fn peek_max_item(&self) -> Option<(K, &T)>

Returns a reference to the item with the highest K value or None if the queue is empty. Does not remove the item from the queue.

pub fn has_item(&self, current_key: &K) -> bool

Returns whether or not there is an item with a key more recent or equal to current_key that is ready to be returned (i.e. we are beyond the instant associated with the item)

pub fn peek_item(&self, current_key: &K) -> Option<(K, &T)>

Same as pop_item but does not remove the item from the queue

pub fn pop_item(&mut self, current_key: &K) -> Option<(K, T)>

Pops the top item (with smallest key) from the queue if the key is above the provided current_key (i.e. we are beyond the instant associated with the item)

pub fn pop_until(&mut self, key: &K) -> Option<(K, T)>

Pop all items that are older or equal than the provided key, then return the value for the most recent item with a key older or equal to the provided key (i.e. if we have keys 1, 4, 6, pop_until(5) will pop 1, 4 and return the value for key 4) /// (i.e. if we have keys 1, 4, 6, pop_until(4) will pop 1, 4 and return the value for key 4)

pub fn drain_until(&mut self, key: &K) -> Vec<(K, T)>

Pop all items that are older or equal than the provided key, then return all the values that were popped

pub fn drain(&mut self) -> impl Iterator<Item = (K, T)>

pub fn drain_after(&mut self, key: &K) -> Vec<(K, T)>

Pop all items that are more recent or equal than the provided key, then return all the values that were popped

pub fn len(&self) -> usize

Returns the length of the underlying queue

pub fn is_empty(&self) -> bool

Checks if the underlying queue is empty

pub fn clear(&mut self)

Trait Implementations

impl<K: Clone, T: Clone> Clone for ReadyBuffer<K, T>

fn clone(&self) -> ReadyBuffer<K, T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<K: Debug, T: Debug> Debug for ReadyBuffer<K, T>

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

Formats the value using the given formatter.

impl<K: Ord, T> Default for ReadyBuffer<K, T>

fn default() -> Self

Returns the “default value” for a type.

impl<K, T> FromReflect for ReadyBuffer<K, T>

where ReadyBuffer<K, T>: Any + Send + Sync, K: TypePath, T: TypePath, BinaryHeap<ItemWithReadyKey<K, T>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn PartialReflect>, ) -> Result<Self, Box<dyn PartialReflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl<K, T> GetTypeRegistration for ReadyBuffer<K, T>

where ReadyBuffer<K, T>: Any + Send + Sync, K: TypePath, T: TypePath, BinaryHeap<ItemWithReadyKey<K, T>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl<K, T> PartialReflect for ReadyBuffer<K, T>

where ReadyBuffer<K, T>: Any + Send + Sync, K: TypePath, T: TypePath, BinaryHeap<ItemWithReadyKey<K, T>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn try_apply(&mut self, value: &dyn PartialReflect) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<Self>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

fn try_as_reflect(&self) -> Option<&dyn Reflect>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut dyn Reflect>

Attempts to cast this type to a mutable, fully-reflected value.

fn into_partial_reflect(self: Box<Self>) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &dyn PartialReflect

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut dyn PartialReflect

Casts this type to a mutable, reflected value.

fn reflect_partial_eq(&self, value: &dyn PartialReflect) -> Option<bool>

Returns a “partial equality” comparison result.

fn reflect_clone(&self) -> Result<Box<dyn Reflect>, ReflectCloneError>

Attempts to clone Self using reflection.

fn apply(&mut self, value: &(dyn PartialReflect + 'static))

Applies a reflected value to this value.

fn to_dynamic(&self) -> Box<dyn PartialReflect>

Converts this reflected value into its dynamic representation based on its kind.

fn reflect_clone_and_take<T>(&self) -> Result<T, ReflectCloneError>

where T: 'static, Self: Sized + TypePath,

For a type implementing PartialReflect, combines reflect_clone and take in a useful fashion, automatically constructing an appropriate ReflectCloneError if the downcast fails.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

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

Debug formatter for the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl<K, T> Reflect for ReadyBuffer<K, T>

where ReadyBuffer<K, T>: Any + Send + Sync, K: TypePath, T: TypePath, BinaryHeap<ItemWithReadyKey<K, T>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn into_any(self: Box<Self>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

Casts this type to a boxed, fully-reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a fully-reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable, fully-reflected value.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

impl<K, T> Struct for ReadyBuffer<K, T>

where ReadyBuffer<K, T>: Any + Send + Sync, K: TypePath, T: TypePath, BinaryHeap<ItemWithReadyKey<K, T>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn field(&self, name: &str) -> Option<&dyn PartialReflect>

Returns a reference to the value of the field named name as a &dyn PartialReflect.

fn field_mut(&mut self, name: &str) -> Option<&mut dyn PartialReflect>

Returns a mutable reference to the value of the field named name as a &mut dyn PartialReflect.

fn field_at(&self, index: usize) -> Option<&dyn PartialReflect>

Returns a reference to the value of the field with index index as a &dyn PartialReflect.

fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn PartialReflect>

Returns a mutable reference to the value of the field with index index as a &mut dyn PartialReflect.

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn to_dynamic_struct(&self) -> DynamicStruct

Creates a new DynamicStruct from this struct.

fn get_represented_struct_info(&self) -> Option<&'static StructInfo>

Will return None if TypeInfo is not available.

impl<K, T> TypePath for ReadyBuffer<K, T>

where ReadyBuffer<K, T>: Any + Send + Sync, K: TypePath, T: TypePath,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl<K, T> Typed for ReadyBuffer<K, T>

where ReadyBuffer<K, T>: Any + Send + Sync, K: TypePath, T: TypePath, BinaryHeap<ItemWithReadyKey<K, T>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.