Struct PaginatedQueryRet 

pub struct PaginatedQueryRet<T, C> {
    pub entities: Vec<T>,
    pub has_next_page: bool,
    pub end_cursor: Option<C>,
}

Return type for paginated queries containing entities and pagination metadata

PaginatedQueryRet contains the fetched entities and utilities for continuing pagination. Returned by the EsRepo functions like list_by, list_for, list_for_filter. Used with PaginatedQueryArgs to perform consistent and efficient pagination

Examples

let query_args = PaginatedQueryArgs {
    first: 10,
    after: None,
};

// Execute query and get the `result` of type `PaginatedQueryRet`
let result = users.list_by_id(query_args, ListDirection::Ascending).await?;

// Continue pagination using the `next_query_args` argument updated using result
// Will continue only if 'has_next_page` returned from `result` is true
if result.has_next_page {
    let next_query_args = PaginatedQueryArgs {
        first: 10,
        after: result.end_cursor, // update with 'end_cursor' of previous result
    };
    let next_result = users.list_by_id(next_query_args, ListDirection::Ascending).await?;
}

// Or use PaginatedQueryRet::into_next_query() convenience method
if let Some(next_query_args) = result.into_next_query() {
    let next_result = users.list_by_id(next_query_args, ListDirection::Ascending).await?;
}

Fields

entities: Vec<T>

Vec for the fetched entities by the paginated query

has_next_page: bool

bool for indicating if the list has been exhausted or more entities can be fetched

end_cursor: Option<C>

cursor on the last entity fetched to continue paginated queries.

Implementations

impl<T, C> PaginatedQueryRet<T, C>

pub fn into_next_query(self) -> Option<PaginatedQueryArgs<C>>

where C: Debug,

Convenience method to create next query args if more pages are available