Struct bonsaidb::core::schema::AsyncList

pub struct AsyncList<'a, Cn, Cl, PrimaryKey>(_)
 where
    Cl: Collection;

Retrieves a list of documents from a collection, when awaited. This structure also offers functions to customize the options for the operation.

Implementations

impl<'a, Cn, Cl, PrimaryKey> AsyncList<'a, Cn, Cl, PrimaryKey> where
    Cl: Collection,
    Cn: AsyncConnection,
    PrimaryKey: for<'k> KeyEncoding<'k, <Cl as Collection>::PrimaryKey>, 

pub fn ascending(self) -> AsyncList<'a, Cn, Cl, PrimaryKey>

Lists documents by id in ascending order.

pub fn descending(self) -> AsyncList<'a, Cn, Cl, PrimaryKey>

Lists documents by id in descending order.

pub fn limit(self, maximum_results: u32) -> AsyncList<'a, Cn, Cl, PrimaryKey>

Sets the maximum number of results to return.

pub async fn count(self) -> Result<u64, Error>

Returns the number of documents contained within the range.

Order and limit are ignored if they were set.

println!(
    "Number of documents with id 42 or larger: {}",
    MyCollection::list_async(42.., db).count().await?
);
println!(
    "Number of documents in MyCollection: {}",
    MyCollection::all_async(db).count().await?
);

pub async fn headers(self) -> Result<Vec<Header, Global>, Error>

Returns the list of document headers contained within the range.

println!(
    "Headers with id 42 or larger: {:?}",
    MyCollection::list_async(42.., db).headers().await?
);
println!(
    "Headers in MyCollection: {:?}",
    MyCollection::all_async(db).headers().await?
);

Trait Implementations

impl<'a, Cn, Cl, PrimaryKey> Future for AsyncList<'a, Cn, Cl, PrimaryKey> where
    Cl: SerializedCollection + Unpin,
    Cn: AsyncConnection,
    PrimaryKey: 'a + for<'k> KeyEncoding<'k, <Cl as Collection>::PrimaryKey> + Unpin,
    <Cl as Collection>::PrimaryKey: Unpin, 

type Output = Result<Vec<CollectionDocument<Cl>, Global>, Error>

The type of value produced on completion.

pub fn poll(
    self: Pin<&mut AsyncList<'a, Cn, Cl, PrimaryKey>>,
    cx: &mut Context<'_>
) -> Poll<<AsyncList<'a, Cn, Cl, PrimaryKey> 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.