Struct bonsaidb::core::schema::AsyncEntry

pub struct AsyncEntry<'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> AsyncEntry<'a, 'name, Connection, Col, EI, EU>

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

pub fn or_insert_with<F>( self, cb: F ) -> AsyncEntry<'a, 'name, Connection, Col, F, EU>

where F: EntryInsert<Col> + 'a + Unpin,

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>( self, cb: F ) -> AsyncEntry<'a, 'name, Connection, Col, EI, F>

where F: EntryUpdate<Col> + 'a + Unpin,

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 fn retry_limit( self, attempts: usize ) -> AsyncEntry<'a, 'name, Connection, Col, EI, EU>

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

Trait Implementations

impl<'a, 'name, Conn, Col, EI, EU> Future for AsyncEntry<'a, 'name, Conn, Col, EI, EU>

where 'name: 'a, Col: NamedCollection + SerializedCollection + 'static, <Col as Collection>::PrimaryKey: Unpin, Conn: AsyncConnection, EI: EntryInsert<Col> + 'a, EU: EntryUpdate<Col> + 'a,

type Output = Result<Option<CollectionDocument<Col>>, Error>

The type of value produced on completion.

fn poll( self: Pin<&mut AsyncEntry<'a, 'name, Conn, Col, EI, EU>>, cx: &mut Context<'_> ) -> Poll<<AsyncEntry<'a, 'name, Conn, Col, EI, EU> as Future>::Output>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.