Struct bonsaidb_core::connection::Collection

pub struct Collection<'a, Cn, Cl> { /* private fields */ }

Interacts with a collection over a Connection.

Implementations

impl<'a, Cn, Cl> Collection<'a, Cn, Cl> where
    Cn: Connection,
    Cl: Collection, 

pub fn new(connection: &'a Cn) -> Self

Creates a new instance using connection.

pub async fn push(
    &self,
    item: &<Cl as SerializedCollection>::Contents
) -> Result<Header, Error> where
    Cl: SerializedCollection, 

Adds a new Document<Cl> with the contents item.

pub async fn push_bytes<B: Into<Bytes> + Send>(
    &self,
    contents: B
) -> Result<Header, Error> where
    Cl: SerializedCollection, 

Adds a new Document<Cl> with the contents.

pub async fn insert(
    &self,
    id: u64,
    item: &<Cl as SerializedCollection>::Contents
) -> Result<Header, Error> where
    Cl: SerializedCollection, 

Adds a new Document<Cl> with the given id and contents item.

pub async fn insert_bytes<B: Into<Bytes> + Send>(
    &self,
    id: u64,
    contents: B
) -> Result<Header, Error> where
    Cl: SerializedCollection, 

Adds a new Document<Cl> with the the given id and contents.

pub async fn get(&self, id: u64) -> Result<Option<OwnedDocument>, Error>

Retrieves a Document<Cl> with id from the connection.

pub async fn get_multiple(
    &self,
    ids: &[u64]
) -> Result<Vec<OwnedDocument>, Error>

Retrieves all documents matching ids. Documents that are not found are not returned, but no error will be generated.

pub fn list<R: Into<Range<u64>>>(&'a self, ids: R) -> List<'a, Cn, Cl>

Retrieves all documents matching ids. Documents that are not found are not returned, but no error will be generated.

pub async fn delete<H: AsRef<Header> + Send + Sync>(
    &self,
    doc: &H
) -> Result<(), Error>

Removes a Document from the database.

Trait Implementations

impl<'a, Cn, Cl> Clone for Collection<'a, Cn, Cl>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.