Struct Paginator

pub struct Paginator<'db, C, S>
where
    C: ConnectionTrait,
    S: SelectorTrait + 'db,
{ /* private fields */ }

Defined a structure to handle pagination of a result from a query operation on a Model

Implementations

impl<'db, C, S> Paginator<'db, C, S>

where C: ConnectionTrait, S: SelectorTrait + 'db,

pub async fn fetch_page( &self, page: u64, ) -> Result<Vec<<S as SelectorTrait>::Item>, DbErr>

Fetch a specific page; page index starts from zero

pub async fn fetch(&self) -> Result<Vec<<S as SelectorTrait>::Item>, DbErr>

Fetch the current page

pub async fn num_items(&self) -> Result<u64, DbErr>

Get the total number of items

pub async fn num_pages(&self) -> Result<u64, DbErr>

Get the total number of pages

pub async fn num_items_and_pages(&self) -> Result<ItemsAndPagesNumber, DbErr>

Get the total number of items and pages

pub fn next(&mut self)

Increment the page counter

pub fn cur_page(&self) -> u64

Get current page number

pub async fn fetch_and_next( &mut self, ) -> Result<Option<Vec<<S as SelectorTrait>::Item>>, DbErr>

Fetch one page and increment the page counter

use sea_orm::{entity::*, query::*, tests_cfg::cake};
let mut cake_pages = cake::Entity::find()
    .order_by_asc(cake::Column::Id)
    .paginate(db, 50);

while let Some(cakes) = cake_pages.fetch_and_next().await? {
    // Do something on cakes: Vec<cake::Model>
}

pub fn into_stream( self, ) -> Pin<Box<dyn Stream<Item = Result<Vec<<S as SelectorTrait>::Item>, DbErr>> + 'db>>

Convert self into an async stream

use futures::TryStreamExt;
use sea_orm::{entity::*, query::*, tests_cfg::cake};
let mut cake_stream = cake::Entity::find()
    .order_by_asc(cake::Column::Id)
    .paginate(db, 50)
    .into_stream();

while let Some(cakes) = cake_stream.try_next().await? {
    // Do something on cakes: Vec<cake::Model>
}

Trait Implementations

impl<'db, C, S> Clone for Paginator<'db, C, S>

where C: Clone + ConnectionTrait, S: Clone + SelectorTrait + 'db,

fn clone(&self) -> Paginator<'db, C, S>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'db, C, S> Debug for Paginator<'db, C, S>

where C: Debug + ConnectionTrait, S: Debug + SelectorTrait + 'db,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.