Struct airone::database::AironeDb

pub struct AironeDb<T, SaveMode = AutoSave>
where
    T: InnerStruct,
    SaveMode: SaveModeExt,
{ /* private fields */ }

Implementations

impl<T: InnerStruct, SaveMode: SaveModeExt> AironeDb<T, SaveMode>

pub fn new() -> Result<Self, Error>

pub fn new_with_custom_name(custom_name: &str) -> Result<Self, Error>

pub fn get_all(&self) -> &[T]

pub fn get(&self, index: usize) -> Option<&T>

pub fn get_mut(&mut self, index: usize) -> Option<WriteProxy<'_, T, SaveMode>>

Mutably access the element at the specified index

pub fn len(&self) -> usize

Returns the number of elements in the list

pub fn is_empty(&self) -> bool

Checks if the inner array is empty

pub fn set_buffer_mode(&mut self, mode: BufferMode) -> Result<(), Error>

pub fn iter(&self) -> impl Iterator<Item = &T>

pub fn set_save_mode<NewSaveMode: SaveModeExt>( self ) -> Result<AironeDb<T, NewSaveMode>, Error>

Change the SaveMode to the provided value

For example, you can convert a db to ManualSave or AutoSave mode. While changing mode, any pending change is written to disk and you won’t be able to rollback.

impl<T: InnerStruct> AironeDb<T, AutoSave>

pub fn insert(&mut self, index: usize, element: T) -> Result<(), Error>

Inserts an element at position index within the vector, shifting all elements after it to the right.

Panics

Panics if index > len.

pub fn push(&mut self, element: T) -> Result<(), Error>

Adds a new element to the end of the list

pub fn pop(&mut self) -> Result<Option<T>, Error>

Removes the last element of the list and returns it if existing

pub fn extend(&mut self, iter: impl Iterator<Item = T>) -> Result<(), Error>

Adds the elements of an iterator to the end of the list.

pub fn append(&mut self, other: &mut Vec<T>) -> Result<(), Error>

Adds multiple elements to the end of the list, automatically reducing the number of syscalls to write them to disk

Works similar to https://doc.rust-lang.org/std/vec/struct.Vec.html#method.append

pub fn dedup(&mut self) -> Result<(), Error>

where T: PartialEq,

Removes consecutive duplicates

pub fn remove(&mut self, index: usize) -> Result<T, Error>

Removes and returns the element at index. Panics if out of bounds.

pub fn drain( &mut self, range: impl RangeBounds<usize> ) -> Result<impl Iterator<Item = T>, Error>

Removes the specified range in bulk and returns an iterator over the removed elements

pub fn retain<F: Fn(&T) -> bool>(&mut self, f: F) -> Result<(), Error>

Keeps only the elements that match the predicate

Removes all the elements that do not satisfy the condition

pub fn clear(&mut self) -> Result<(), Error>

Deletes all elements from the list

pub fn set<V: SerializableField>( &mut self, index: usize, fieldname: &'static str, value: V ) -> Result<(), Error>

impl<T: InnerStruct> AironeDb<T, ManualSave>

pub fn insert(&mut self, index: usize, element: T)

Inserts an element at position index within the vector, shifting all elements after it to the right.

Panics

Panics if index > len.

pub fn push(&mut self, element: T)

Adds a new element to the end of the list

pub fn pop(&mut self) -> Option<T>

Removes the last element of the list and returns it if existing

pub fn extend(&mut self, iter: impl Iterator<Item = T>)

Adds the elements of an iterator to the end of the list.

pub fn append(&mut self, other: &mut Vec<T>)

Adds multiple elements to the end of the list, automatically reducing the number of syscalls to write them to disk

Works similar to https://doc.rust-lang.org/std/vec/struct.Vec.html#method.append

pub fn dedup(&mut self)

where T: PartialEq,

Removes consecutive duplicates

pub fn remove(&mut self, index: usize) -> T

Removes and returns the element at index. Panics if out of bounds.

pub fn drain( &mut self, range: impl RangeBounds<usize> ) -> impl Iterator<Item = T>

Removes the specified range in bulk and returns an iterator over the removed elements

pub fn retain<F: Fn(&T) -> bool>(&mut self, f: F)

Keeps only the elements that match the predicate

Removes all the elements that do not satisfy the condition

pub fn clear(&mut self)

Deletes all elements from the list

pub fn set<V: SerializableField>( &mut self, index: usize, fieldname: &'static str, value: V )

pub fn save(&mut self) -> Result<(), Error>

Saves to file all in-memory transactions, to persist the current db state.

pub fn rollback(&mut self)

Rollbacks the data in memory to the last known state which was persisted to disk

Trait Implementations

impl<T, SaveMode> Index<usize> for AironeDb<T, SaveMode>

where T: InnerStruct, SaveMode: SaveModeExt,

External traits

type Output = T

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.