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

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

Implementations§

source§

impl<'a, Cn, Cl, PrimaryKey> List<'a, Cn, Cl, PrimaryKey>where Cl: Collection, Cn: Connection, PrimaryKey: KeyEncoding<Cl::PrimaryKey> + PartialEq + 'a + ?Sized, Cl::PrimaryKey: Borrow<PrimaryKey> + PartialEq<PrimaryKey>,

source

pub const fn ascending(self) -> Self

Lists documents by id in ascending order.

source

pub const fn descending(self) -> Self

Lists documents by id in descending order.

source

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

Sets the maximum number of results to return.

source

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

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

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

println!(
    "Headers with id 42 or larger: {:?}",
    db.collection::<MyCollection>().list(&42..).headers()?
);
println!(
    "Headers in MyCollection: {:?}",
    db.collection::<MyCollection>().all().headers()?
);
source

pub fn query(self) -> Result<Vec<OwnedDocument>, Error>

Retrieves the matching documents.

for doc in db.collection::<MyCollection>().all().query()? {
    println!("Retrieved #{} with bytes {:?}", doc.header.id, doc.contents);
    let deserialized = MyCollection::document_contents(&doc)?;
    println!("Deserialized contents: {:?}", deserialized);
}

Auto Trait Implementations§

§

impl<'a, Cn, Cl, PrimaryKey: ?Sized> RefUnwindSafe for List<'a, Cn, Cl, PrimaryKey>where Cl: RefUnwindSafe, Cn: RefUnwindSafe, PrimaryKey: RefUnwindSafe, <Cl as Collection>::PrimaryKey: RefUnwindSafe,

§

impl<'a, Cn, Cl, PrimaryKey: ?Sized> Send for List<'a, Cn, Cl, PrimaryKey>where Cn: Sync, PrimaryKey: Sync,

§

impl<'a, Cn, Cl, PrimaryKey: ?Sized> Sync for List<'a, Cn, Cl, PrimaryKey>where Cn: Sync, PrimaryKey: Sync,

§

impl<'a, Cn, Cl, PrimaryKey: ?Sized> Unpin for List<'a, Cn, Cl, PrimaryKey>where Cl: Unpin, <Cl as Collection>::PrimaryKey: Unpin,

§

impl<'a, Cn, Cl, PrimaryKey: ?Sized> UnwindSafe for List<'a, Cn, Cl, PrimaryKey>where Cl: UnwindSafe + RefUnwindSafe, Cn: RefUnwindSafe, PrimaryKey: RefUnwindSafe, <Cl as Collection>::PrimaryKey: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more