Struct Table

pub struct Table<V>
where
    V: PrimaryKey + Serialize + for<'a> Deserialize<'a>,
    V::PrimaryKeyType: Ord + FromStr + Display + Debug + Clone,
    <<V as PrimaryKey>::PrimaryKeyType as FromStr>::Err: Display,
{ /* private fields */ }

Represents a database table utilizing a BTreeMap for underlying data storage. Needs the PrimaryKey trait to be implemented for the value type. Offers enhanced methods for manipulating records, including add, edit, delete, get, and search.

use light_magic::{
    serde::{Deserialize, Serialize},
    table::{PrimaryKey, Table},
};

#[derive(Default, Debug, Clone, Serialize, Deserialize)]
struct User {
    id: usize,
    name: String,
    age: usize,
}

impl PrimaryKey for User {
    type PrimaryKeyType = usize;

    fn primary_key(&self) -> &Self::PrimaryKeyType {
        &self.id
    }
}

Implementations

impl<V> Table<V>

where V: PrimaryKey + Serialize + for<'a> Deserialize<'a>, V::PrimaryKeyType: Ord + FromStr + Display + Debug + Clone, <<V as PrimaryKey>::PrimaryKeyType as FromStr>::Err: Display,

pub fn add(&mut self, value: V) -> Option<V>

where V: Clone, V::PrimaryKeyType: Clone,

Adds an entry to the table, returns the value or None if the addition failed

pub fn get(&self, key: &V::PrimaryKeyType) -> Option<&V>

Gets an entry from the table, returns the value or None if it couldn’t find the data

pub fn get_mut(&mut self, key: &V::PrimaryKeyType) -> Option<&mut V>

Gets an mutable entry from the table, returns the value or None if it couldn’t find the data

pub fn edit(&mut self, key: &V::PrimaryKeyType, new_value: V) -> Option<V>

where V: Clone, V::PrimaryKeyType: Clone,

Edits an entry in the table, returns the new_value or None if the editing failed

pub fn delete(&mut self, key: &V::PrimaryKeyType) -> Option<V>

Deletes an entry from the table, returns the value or None if the deletion failed

pub fn search<F>(&self, predicate: F) -> Vec<&V>

where F: Fn(&V) -> bool,

Searches the table by a predicate function

pub fn search_ordered<F, O>(&self, predicate: F, comparator: O) -> Vec<&V>

where F: Fn(&V) -> bool, O: Fn(&&V, &&V) -> Ordering,

Searches the table by a predicate function and a custom ordering with a comparator function

pub fn values(&self) -> Values<'_, V::PrimaryKeyType, V>

Gets an iterator over the values of the map, in order by key.

pub fn values_mut(&mut self) -> ValuesMut<'_, V::PrimaryKeyType, V>

Gets a mutable iterator over the values of the map, in order by key.

Trait Implementations

impl<V> Clone for Table<V>

where V: PrimaryKey + Serialize + for<'a> Deserialize<'a> + Clone, V::PrimaryKeyType: Ord + FromStr + Display + Debug + Clone, <<V as PrimaryKey>::PrimaryKeyType as FromStr>::Err: Display,

fn clone(&self) -> Table<V>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<V> Debug for Table<V>

where V: PrimaryKey + Serialize + for<'a> Deserialize<'a> + Debug, V::PrimaryKeyType: Ord + FromStr + Display + Debug + Clone, <<V as PrimaryKey>::PrimaryKeyType as FromStr>::Err: Display,

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

Formats the value using the given formatter.

impl<V> Default for Table<V>

where V: PrimaryKey + Serialize + for<'a> Deserialize<'a> + Default, V::PrimaryKeyType: Ord + FromStr + Display + Debug + Clone, <<V as PrimaryKey>::PrimaryKeyType as FromStr>::Err: Display,

fn default() -> Table<V>

Returns the “default value” for a type.

impl<'de, V> Deserialize<'de> for Table<V>

where V: PrimaryKey + Serialize + for<'a> Deserialize<'a>, V::PrimaryKeyType: Ord + FromStr + Display + Debug + Clone, <<V as PrimaryKey>::PrimaryKeyType as FromStr>::Err: Display,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<V> Serialize for Table<V>

where V: PrimaryKey + Serialize + for<'a> Deserialize<'a>, V::PrimaryKeyType: Ord + FromStr + Display + Debug + Clone, <<V as PrimaryKey>::PrimaryKeyType as FromStr>::Err: Display,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.