Struct Cursor 

pub struct Cursor<E: EntityTrait, M> { /* private fields */ }

A keyset-paginated SELECT.

Built by Select::cursor_by. Set the boundary with after or before, the page size and direction with first or last, then run all.

Implementations

impl<E: EntityTrait, M: FromQueryResult> Cursor<E, M>

pub fn after(self, key: impl IntoValueTuple) -> Self

Returns rows whose key is strictly greater than key.

pub fn before(self, key: impl IntoValueTuple) -> Self

Returns rows whose key is strictly less than key.

pub fn first(self, n: u64) -> Self

Takes the first n rows of the key range, in key order.

pub fn last(self, n: u64) -> Self

Takes the last n rows of the key range, still returned in key order.

The statement reads them in reverse order with LIMIT n and the result is reversed in memory, which is the only way to take the tail of a range without knowing its size.

pub fn asc(self) -> Self

Orders the key ascending, the default.

pub fn desc(self) -> Self

Orders the key descending, so that after moves towards smaller keys.

pub fn into_model<T: FromQueryResult>(self) -> Cursor<E, T>

Decodes rows into T instead of the current result type.

pub fn build(&self) -> Statement

Renders the statement.

pub async fn all<C: ConnectionTrait>(&self, db: &C) -> Result<Vec<M>>

Fetches the page, in key order.

Errors

Returns DbErr::Driver when the query fails or a row cannot be decoded.

pub fn key_columns(&self) -> Vec<&'static str>

The names of the key columns, most significant first.

Trait Implementations

impl<E: Clone + EntityTrait, M: Clone> Clone for Cursor<E, M>

where E::Column: Clone,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<E: Debug + EntityTrait, M: Debug> Debug for Cursor<E, M>

where E::Column: Debug,

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

Formats the value using the given formatter.