Struct bonsaidb_core::schema::Entry

pub struct Entry<'a, 'name, Connection, Col, EI, EU>
where
    Col: NamedCollection + SerializedCollection,
    EI: EntryInsert<Col>,
    EU: EntryUpdate<Col>,
{ /* private fields */ }

A future that resolves to an entry in a NamedCollection.

Implementations

impl<'a, 'name, Connection, Col, EI, EU> Entry<'a, 'name, Connection, Col, EI, EU>

where Col: NamedCollection + SerializedCollection + 'static + Unpin, Connection: Connection, EI: EntryInsert<Col> + 'a + Unpin, EU: EntryUpdate<Col> + 'a + Unpin, 'name: 'a,

pub fn execute(self) -> Result<Option<CollectionDocument<Col>>, Error>

Retrieves the document, if found/inserted.

pub fn or_insert_with<F: EntryInsert<Col> + 'a + Unpin>( self, cb: F ) -> Entry<'a, 'name, Connection, Col, F, EU>

If an entry with the key doesn’t exist, cb will be executed to provide an initial document. This document will be saved before being returned.

pub fn update_with<F: EntryUpdate<Col> + 'a + Unpin>( self, cb: F ) -> Entry<'a, 'name, Connection, Col, EI, F>

If an entry with the keys exists, cb will be executed with the stored value, allowing an opportunity to update the value. This new value will be saved to the database before returning. If an error occurs during update, cb may be invoked multiple times, up to the retry_limit.

pub const fn retry_limit(self, attempts: usize) -> Self

The number of attempts to attempt updating the document using update_with before returning an error.