Trait Collection 

pub trait Collection {
    type Idx;
    type Output: ?Sized;
    type ShadowLocks: ShadowLocksCollection<Idx = Self::Idx>;
    type ShadowLocksAsync: ShadowLocksCollectionAsync<Idx = Self::Idx>;

    // Required methods
    fn index(&self, index: impl Borrow<Self::Idx>) -> Option<&Self::Output>;
    fn index_mut(
        &mut self,
        index: impl Borrow<Self::Idx>,
    ) -> Option<&mut Self::Output>;
    fn indices(&self) -> impl Iterator<Item = Self::Idx>;
    fn shadow_locks(&self) -> Self::ShadowLocks;
    fn shadow_locks_async(&self) -> Self::ShadowLocksAsync;
}

Trait describes functionality of collection that necessary for creating LockerRoom and LockerRoomAsync.

Required Associated Types

type Idx

Type that should be used as index

type Output: ?Sized

The returned type after indexing.

type ShadowLocks: ShadowLocksCollection<Idx = Self::Idx>

Type of collection which stores RwLocks. Usually the same type as Collection’s implementor.

It’s necessary because of performance. For example, implementing Collection for Vec but using BTreeMap as ShadowLocks makes little sense because LockerRoom at every index (or index_mut) method call will also call the same method of ShadowLocks. This makes meaningless to use Vec because its performance will be bottlenecked by BTreeMap.

type ShadowLocksAsync: ShadowLocksCollectionAsync<Idx = Self::Idx>

Available on crate feature async only.

Similar to ShadowLocks but stores tokio’s RwLocks.

Used in LockerRoomAsync.

Required Methods

fn index(&self, index: impl Borrow<Self::Idx>) -> Option<&Self::Output>

Performs the indexing operation. But unlike the Index::index, it doesn’t panic, and return None.

fn index_mut( &mut self, index: impl Borrow<Self::Idx>, ) -> Option<&mut Self::Output>

Performs the mutable indexing operation. But unlike the IndexMut::index_mut, it doesn’t panic, and return None.

fn indices(&self) -> impl Iterator<Item = Self::Idx>

An iterator visiting all indices.

fn shadow_locks(&self) -> Self::ShadowLocks

Creates collection which stores RwLocks.

Used in LockerRoom.

fn shadow_locks_async(&self) -> Self::ShadowLocksAsync

Available on crate feature async only.

Creates collection wich stores tokio’s RwLocks.

Used in LockerRoomAsync.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl<K, V> Collection for BTreeMap<K, V>

where K: Ord + Clone + ?Sized,

type Idx = K

type Output = V

type ShadowLocks = BTreeMap<<BTreeMap<K, V> as Collection>::Idx, RwLock<()>>

type ShadowLocksAsync = BTreeMap<<BTreeMap<K, V> as Collection>::Idx, RwLock<()>>

Available on crate feature async only.

fn index(&self, index: impl Borrow<Self::Idx>) -> Option<&Self::Output>

fn index_mut( &mut self, index: impl Borrow<Self::Idx>, ) -> Option<&mut Self::Output>

fn indices(&self) -> impl Iterator<Item = Self::Idx>

fn shadow_locks(&self) -> Self::ShadowLocks

fn shadow_locks_async(&self) -> Self::ShadowLocksAsync

Available on crate feature async only.

impl<K, V> Collection for HashMap<K, V>

where K: Eq + Hash + Clone + ?Sized,

type Idx = K

type Output = V

type ShadowLocks = HashMap<<HashMap<K, V> as Collection>::Idx, RwLock<()>>

type ShadowLocksAsync = HashMap<<HashMap<K, V> as Collection>::Idx, RwLock<()>>

Available on crate feature async only.

fn index(&self, index: impl Borrow<Self::Idx>) -> Option<&Self::Output>

fn index_mut( &mut self, index: impl Borrow<Self::Idx>, ) -> Option<&mut Self::Output>

fn indices(&self) -> impl Iterator<Item = Self::Idx>

fn shadow_locks(&self) -> Self::ShadowLocks

fn shadow_locks_async(&self) -> Self::ShadowLocksAsync

Available on crate feature async only.

impl<T> Collection for [T]

type Idx = usize

type Output = T

type ShadowLocks = Vec<RwLock<()>>

type ShadowLocksAsync = Vec<RwLock<()>>

Available on crate feature async only.

fn index(&self, index: impl Borrow<Self::Idx>) -> Option<&Self::Output>

fn index_mut( &mut self, index: impl Borrow<Self::Idx>, ) -> Option<&mut Self::Output>

fn indices(&self) -> impl Iterator<Item = Self::Idx>

fn shadow_locks(&self) -> Self::ShadowLocks

fn shadow_locks_async(&self) -> Self::ShadowLocksAsync

Available on crate feature async only.

impl<T> Collection for VecDeque<T>

type Idx = usize

type Output = T

type ShadowLocks = VecDeque<RwLock<()>>

type ShadowLocksAsync = VecDeque<RwLock<()>>

Available on crate feature async only.

fn index(&self, index: impl Borrow<Self::Idx>) -> Option<&Self::Output>

fn index_mut( &mut self, index: impl Borrow<Self::Idx>, ) -> Option<&mut Self::Output>

fn indices(&self) -> impl Iterator<Item = Self::Idx>

fn shadow_locks(&self) -> Self::ShadowLocks

fn shadow_locks_async(&self) -> Self::ShadowLocksAsync

Available on crate feature async only.

impl<T> Collection for Vec<T>

type Idx = usize

type Output = T

type ShadowLocks = Vec<RwLock<()>>

type ShadowLocksAsync = Vec<RwLock<()>>

Available on crate feature async only.

fn index(&self, index: impl Borrow<Self::Idx>) -> Option<&Self::Output>

fn index_mut( &mut self, index: impl Borrow<Self::Idx>, ) -> Option<&mut Self::Output>

fn indices(&self) -> impl Iterator<Item = Self::Idx>

fn shadow_locks(&self) -> Self::ShadowLocks

fn shadow_locks_async(&self) -> Self::ShadowLocksAsync

Available on crate feature async only.

impl<T, const N: usize> Collection for [T; N]

type Idx = usize

type Output = T

type ShadowLocks = Vec<RwLock<()>>

type ShadowLocksAsync = Vec<RwLock<()>>

Available on crate feature async only.

fn index(&self, index: impl Borrow<Self::Idx>) -> Option<&Self::Output>

fn index_mut( &mut self, index: impl Borrow<Self::Idx>, ) -> Option<&mut Self::Output>

fn indices(&self) -> impl Iterator<Item = Self::Idx>

fn shadow_locks(&self) -> Self::ShadowLocks

fn shadow_locks_async(&self) -> Self::ShadowLocksAsync

Available on crate feature async only.

Implementors