Struct mongodb_cursor_pagination::PaginatedCursor

pub struct PaginatedCursor { /* fields omitted */ }

The main entry point for finding documents

Methods

impl<'a> PaginatedCursor

pub fn new(
    options: Option<FindOptions>,
    cursor: Option<String>,
    direction: Option<CursorDirections>
) -> Self

Updates or creates all of the find options to help with pagination and returns a PaginatedCursor object.

Arguments

• options - Optional find options that you would like to perform any searches with
• cursor - An optional existing cursor in base64. This would have come from a previous FindResult
• direction - Determines whether the cursor supplied is for a previous page or the next page. Defaults to Next

pub fn estimated_document_count(
    &self,
    collection: &Collection
) -> Result<i64, CursorError>

Estimates the number of documents in the collection using collection metadata.

pub fn count_documents(
    &self,
    collection: &Collection,
    query: Option<&Document>
) -> Result<i64, CursorError>

Gets the number of documents matching filter. Note that using PaginatedCursor::estimated_document_count is recommended instead of this method is most cases.

pub fn find<T>(
    &self,
    collection: &Collection,
    filter: Option<&Document>
) -> Result<FindResult<T>, CursorError> where
    T: Deserialize<'a>, 

Finds the documents in the collection matching filter.

Trait Implementations

impl Debug for PaginatedCursor

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.