Struct spartan_lib::core::db::TreeDatabase

pub struct TreeDatabase<M> where
    M: Identifiable + Sortable,
    <M as Identifiable>::Id: Hash,  { /* fields omitted */ }

Tree-based database

Used by default server implementation.

Internally, contains message storage, and index for fast lookups, thus improving performance in comparison with VecDatabase

TreeDatabase heavily relies on correct M implementation of Sortable as only first element of index is used to check if there are any available messages in queue.

Trait Implementations

impl<M> Database<M> for TreeDatabase<M> where
    M: Identifiable + Sortable,
    <M as Identifiable>::Id: Hash, 

type PositionKey = <M as Identifiable>::Id

pub fn push_raw(&mut self, message: M)

Push raw message to database

pub fn position<F>(&self, predicate: F) -> Option<Self::PositionKey> where
    F: Fn(&M) -> bool, 

Get database position key of the first message, that matches predicate

pub fn get(&self, position: Self::PositionKey) -> Option<&M>

Get shared message reference by database position key

pub fn get_mut(&mut self, position: Self::PositionKey) -> Option<&mut M>

Get mutable message reference by database position key

pub fn delete_pos(&mut self, position: Self::PositionKey) -> Option<M>

Delete message by database position key

pub fn retain<F>(&mut self, predicate: F) where
    F: Fn(&M) -> bool, 

Retain only messages, that match predicate

pub fn len(&self) -> usize

Get database size

pub fn is_empty(&self) -> bool

Check if database is empty

pub fn clear(&mut self)

Remove all database messages

impl<M> Default for TreeDatabase<M> where
    M: Identifiable + Sortable,
    <M as Identifiable>::Id: Hash, 

pub fn default() -> Self

Returns the "default value" for a type.

impl<'de, M> Deserialize<'de> for TreeDatabase<M> where
    M: Identifiable + Sortable,
    <M as Identifiable>::Id: Hash,
    <M as Identifiable>::Id: Serialize + DeserializeOwned,
    <M as Sortable>::Sort: Serialize + DeserializeOwned,
    M: Serialize + DeserializeOwned, 

pub fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<M> Serialize for TreeDatabase<M> where
    M: Identifiable + Sortable,
    <M as Identifiable>::Id: Hash,
    <M as Identifiable>::Id: Serialize + DeserializeOwned,
    <M as Sortable>::Sort: Serialize + DeserializeOwned,
    M: Serialize + DeserializeOwned, 

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

Serialize this value into the given Serde serializer.

impl<M> StatusAwareDatabase<M> for TreeDatabase<M> where
    M: Identifiable + Sortable + Status,
    <M as Identifiable>::Id: Hash, 

type RequeueKey = <M as Identifiable>::Id

pub fn reserve(&mut self, position: Self::PositionKey) -> Option<&mut M>

Reserve message in database

pub fn requeue<F>(
    &mut self,
    position: Self::RequeueKey,
    predicate: F
) -> Option<&mut M> where
    F: Fn(&M) -> bool, 

Requeue message back to database