scsys-core 0.3.2

core primitives and utilities for the scsys ecosystem
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

/*
    appellation: get <module>
    authors: @FL03
*/

/// [`Get`] defines an interface for entities that can be accessed by a key; the design is
/// similar to the [`Index`](core::ops::Index) trait in the standard library, however, uses the
/// [`Borrow`](core::borrow::Borrow) trait to allow for more flexible key types.
pub trait Get<T> {
    type Key;
    /// returns a reference to the element at the specified index.
    fn get<Q>(&self, index: Q) -> Option<&T>
    where
        Q: core::borrow::Borrow<Self::Key>;
}
/// [`GetMut`] defines an interface for entities that can be accessed by a key; the design
/// is similar to the [`IndexMut`](core::ops::IndexMut) trait in the standard library
pub trait GetMut<T>: Get<T> {
    /// returns a mutable reference to the element at the specified index.
    fn get_mut<Q>(&mut self, index: Q) -> Option<&mut T>
    where
        Q: core::borrow::Borrow<Self::Key>;
}