Struct bonsaidb_core::connection::AsyncList

pub struct AsyncList<'a, Cn, Cl, PrimaryKey>where
    Cl: Collection,
    PrimaryKey: KeyEncoding<Cl::PrimaryKey> + PartialEq + ?Sized,
    Cl::PrimaryKey: Borrow<PrimaryKey> + PartialEq<PrimaryKey>,{ /* private fields */ }

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: KeyEncoding<Cl::PrimaryKey> + PartialEq + ?Sized, Cl::PrimaryKey: Borrow<PrimaryKey> + PartialEq<PrimaryKey>,

pub fn ascending(self) -> Self

Lists documents by id in ascending order.

pub fn descending(self) -> Self

Lists documents by id in descending order.

pub fn limit(self, maximum_results: u32) -> Self

Sets the maximum number of results to return.

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

Returns the list of headers for documents contained within the range.

println!(
    "Number of documents with id 42 or larger: {:?}",
    db.collection::<MyCollection>().list(42..).headers().await?
);
println!(
    "Number of documents in MyCollection: {:?}",
    db.collection::<MyCollection>().all().headers().await?
);

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: {}",
    db.collection::<MyCollection>().list(42..).count().await?
);
println!(
    "Number of documents in MyCollection: {}",
    db.collection::<MyCollection>().all().count().await?
);

Trait Implementations

impl<'a, Cn, Cl, PrimaryKey> Future for AsyncList<'a, Cn, Cl, PrimaryKey>where Cn: AsyncConnection, Cl: Collection + Unpin, PrimaryKey: KeyEncoding<Cl::PrimaryKey> + PartialEq + ?Sized + Unpin, Cl::PrimaryKey: Borrow<PrimaryKey> + PartialEq<PrimaryKey> + Unpin,

type Output = Result<Vec<OwnedDocument, Global>, Error>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

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