Struct backend::db::pagination::PaginatedQuery

pub struct PaginatedQuery<T> {
    query: T,
    page: i32,
    per_page: i32,
    offset: i32,
}

An executable paginated query.

Fields

query: T

Executable query.

page: i32

Page number to be loaded.

per_page: i32

Number of rows loaded in the query.

offset: i32

Offset to the the first row in the query.

Implementations

impl<T> PaginatedQuery<T>

pub fn per_page(self, per_page: Option<i32>) -> Self

Set the number of rows returned by the query.

pub async fn load_page<'query, 'conn, U>( self, conn: &'conn mut AsyncPgConnection, ) -> QueryResult<Page<U>>

where T: Send, U: Send, Self: LoadQuery<'query, AsyncPgConnection, (U, i64)> + 'query,

Execute the query returning one Page of rows.

Errors

Unknown, diesel doesn’t say why it might error.

Trait Implementations

impl<T: Clone> Clone for PaginatedQuery<T>

fn clone(&self) -> PaginatedQuery<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for PaginatedQuery<T>

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

Formats the value using the given formatter.

impl<T: Query> Query for PaginatedQuery<T>

type SqlType = (<T as Query>::SqlType, BigInt)

The SQL type that this query represents.

impl<T> QueryFragment<Pg> for PaginatedQuery<T>

where T: QueryFragment<Pg>,

fn walk_ast<'b>(&'b self, out: AstPass<'_, 'b, Pg>) -> QueryResult<()>

Walk over this QueryFragment for all passes.

fn to_sql( &self, out: &mut <DB as Backend>::QueryBuilder, backend: &DB, ) -> Result<(), Error>

Converts this QueryFragment to its SQL representation.

fn collect_binds<'b>( &'b self, out: &mut <DB as HasBindCollector<'b>>::BindCollector, metadata_lookup: &mut <DB as TypeMetadata>::MetadataLookup, backend: &'b DB, ) -> Result<(), Error>

Serializes all bind parameters in this query.

fn is_safe_to_cache_prepared(&self, backend: &DB) -> Result<bool, Error>

Is this query safe to store in the prepared statement cache?

fn is_noop(&self, backend: &DB) -> Result<bool, Error>

Does walking this AST have any effect?

impl<T: QueryId> QueryId for PaginatedQuery<T>

type QueryId = PaginatedQuery<<T as QueryId>::QueryId>

A type which uniquely represents Self in a SQL query.

const HAS_STATIC_QUERY_ID: bool = _

Can the SQL generated by Self be uniquely identified by its type?

fn query_id() -> Option<TypeId>

Returns the type id of Self::QueryId if Self::HAS_STATIC_QUERY_ID. Returns None otherwise.

impl<T: Copy> Copy for PaginatedQuery<T>