Struct Vec

pub struct Vec<T, DS>
where
    DS: DataStore,
{ /* private fields */ }

mimics the API of Vec

Implementations

impl<'a, T, DS> Vec<T, DS>

where DS: DataStore, T: Serialize + DeserializeOwned,

pub fn extend<I, Q>( &mut self, iter: I, ) -> Result<(), ExtendError<I::Item, I::IntoIter, Error<DS::DbError>>>

where I: IntoIterator<Item = &'a Q>, T: Borrow<Q>, Q: Serialize + ?Sized,

Extends the list with the contents of an iterator.

The iterator item may be any borrowed form of the lists item type, as long as the serialized form matches between borrowed and not borrowed.

Errors

This can fail if the underlying database ran into a problem or if serialization failed.

Examples

#[dbstruct::dbstruct(db=btreemap)]
struct Test {
    list: Vec<String>,
}

let db = Test::new()?;
db.list().extend(["one", "two", "three"])?;
assert_eq!(db.list().get(0)?, Some("one".to_owned()));
assert_eq!(db.list().get(2)?, Some("three".to_owned()));

impl<'a, T, E, DS> Vec<T, DS>

where E: Debug, T: Serialize + DeserializeOwned, DS: DataStore<DbError = E>,

This can be quite slow as it gets each element from the db individually. Consider using the Default wrapper instead of this if the VecDeque is “small” enough.

pub fn iter(&self) -> Iter<'_, T, E, DS>

impl<T, E, DS> Vec<T, DS>

where E: Debug, T: Serialize + DeserializeOwned, DS: DataStore<DbError = E>,

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

Returns the element at index if there is one.

Errors

This can fail if the underlying database ran into a problem or if serialization failed.

Examples

#[dbstruct::dbstruct(db=btreemap)]
struct Test {
    list: Vec<String>,
}

let db = Test::new()?;
assert_eq!(db.list().get(0)?, None);
db.list().push("a")?;
db.list().push("b")?;
assert_eq!(db.list().get(0)?, Some("a".to_owned()));

pub fn push<Q>(&self, value: &Q) -> Result<(), Error<E>>

where T: Borrow<Q>, Q: Serialize + ?Sized,

Appends an element to the back of the collection.

The item may be any borrowed form of the lists item type, but the serialized form must match the not borrowed serialized form.

Errors

This can fail if the underlying database ran into a problem or if serialization failed.

Examples

#[dbstruct::dbstruct(db=btreemap)]
struct Test {
    list: Vec<String>,
}

let db = Test::new()?;
db.list().push("a")?;
db.list().push("b")?;

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

Removes the last element from this database vector and returns it, or None if it is empty

Errors

This can fail if the underlying database ran into a problem or if serialization failed.

Examples

#[dbstruct::dbstruct(db=btreemap)]
struct Test {
    list: Vec<String>,
}

let db = Test::new()?;
db.list().extend(["a", "b", "c"])?;
assert_eq!(db.list().pop()?, Some("c".to_owned()));

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

Clears the list, removing all values.

Errors

This can fail if the underlying database ran into a problem or if serialization failed.

Examples

#[dbstruct::dbstruct(db=btreemap)]
struct Test {
    list: Vec<String>,
}

let db = Test::new()?;
db.list().extend(["a", "b", "c"])?;
assert!(!db.list().is_empty());
db.list().clear();
assert!(db.list().is_empty());

pub fn len(&self) -> usize

Returns the number of elements in the list, also referred to as its ‘length’.

Examples

#[dbstruct::dbstruct(db=btreemap)]
struct Test {
    list: Vec<String>,
}

let db = Test::new()?;
db.list().extend(["a", "b", "c"])?;
assert_eq!(db.list().len(), 3);

pub fn is_empty(&self) -> bool

Returns true if the list has a length of 0.

Examples

#[dbstruct::dbstruct(db=btreemap)]
struct Test {
    list_a: Vec<String>,
    list_b: Vec<String>,
}

let db = Test::new()?;
db.list_a().extend(["a", "b", "c"])?;
assert!(!db.list_a().is_empty());
assert!(db.list_b().is_empty());

Trait Implementations

impl<T, E, DS> Debug for Vec<T, DS>

where E: Debug, T: Serialize + DeserializeOwned + Debug, DS: DataStore<DbError = E>,

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

Formats the value using the given formatter.

impl<'a, T, E, DS> IntoIterator for &'a Vec<T, DS>

where E: Debug, T: Serialize + DeserializeOwned, DS: DataStore<DbError = E>,

This can be quite slow as it gets each element from the db individually. Consider using the Default wrapper instead of this if the Vec is “small” enough.

type IntoIter = Iter<'a, T, E, DS>

Which kind of iterator are we turning this into?

type Item = Result<T, Error<E>>

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.