Struct Page 

pub struct Page(/* private fields */);

A page number used for paging in requests.

This is 1-based, so a Page with a value of 0 can not be created.

Implementations

impl Page

pub const MIN: Self

The minimum value of the type.

pub const MAX: Self

The maximum value of the type.

pub const DEFAULT: Self

The default value of the type.

pub const FIRST: Self

The first page.

pub const ONE: Self

The page with number 1.

pub const fn from_i64_clamped(value: i64) -> Self

Create a new Page from an i64 value, clamped to the valid range.

pub const fn saturating_add(self, rhs: Self) -> Self

Add two Page values, saturating.

pub const fn saturating_sub(self, rhs: Self) -> Self

Subtract a Page value from another, saturating.

pub fn saturating_next(&self) -> Self

Get the next page number. Will return itself if this is already the highest possible value.

pub fn saturating_previous(&self) -> Self

Get the previous page number. Will return itself if this is already the lowest possible value.

pub fn as_zero_based_i64(&self) -> i64

Get the zero-based index value as i64.

pub fn as_zero_based_usize(&self) -> usize

Get the zero-based index value as usize.

Trait Implementations

impl<'__expr> AsExpression<BigInt> for &'__expr Page

type Expression = Bound<BigInt, &'__expr Page>

The expression being returned

fn as_expression(self) -> <Self as AsExpression<BigInt>>::Expression

Perform the conversion

impl AsExpression<BigInt> for Page

type Expression = Bound<BigInt, Page>

The expression being returned

fn as_expression(self) -> <Self as AsExpression<BigInt>>::Expression

Perform the conversion

impl<'__expr> AsExpression<Nullable<BigInt>> for &'__expr Page

type Expression = Bound<Nullable<BigInt>, &'__expr Page>

The expression being returned

fn as_expression(self) -> <Self as AsExpression<Nullable<BigInt>>>::Expression

Perform the conversion

impl AsExpression<Nullable<BigInt>> for Page

type Expression = Bound<Nullable<BigInt>, Page>

The expression being returned

fn as_expression(self) -> <Self as AsExpression<Nullable<BigInt>>>::Expression

Perform the conversion

impl AsRef<i64> for Page

fn as_ref(&self) -> &i64

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Page

fn clone(&self) -> Page

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for Page

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for Page

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

Formats the value using the given formatter.

impl Default for Page

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Page

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Page

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

Formats the value using the given formatter.

impl ExampleData for Page

fn example_data() -> Self

Get an example instance of the current datatype.

impl From<Page> for i64

fn from(value: Page) -> Self

Converts to this type from the input type.

impl From<Page> for usize

fn from(Page: Page) -> Self

Converts to this type from the input type.

impl<DB> FromSql<BigInt, DB> for Page

where DB: Backend, i64: FromSql<BigInt, DB>,

fn from_sql(raw: RawValue<'_, DB>) -> Result<Self>

See the trait documentation.

fn from_nullable_sql(raw: Option<RawValue<'_, DB>>) -> Result<Self>

A specialized variant of from_sql for handling null values.

impl Hash for Page

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Page

fn cmp(&self, other: &Page) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Page

fn eq(&self, other: &Page) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Page

fn partial_cmp(&self, other: &Page) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<__DB, __ST> Queryable<__ST, __DB> for Page

where __DB: Backend, __ST: SingleValue, Self: FromSql<__ST, __DB>,

type Row = Page

The Rust type you’d like to map from.

fn build(row: Self) -> Result<Self>

Construct an instance of this type

impl Serialize for Page

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToSchema for Page

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.

impl<DB> ToSql<BigInt, DB> for Page

where DB: Backend, i64: ToSql<BigInt, DB>,

fn to_sql<'b>(&'b self, out: &mut Output<'b, '_, DB>) -> Result

See the trait documentation.

impl<__DB> ToSql<Nullable<BigInt>, __DB> for Page

where __DB: Backend, Self: ToSql<BigInt, __DB>,

fn to_sql<'__b>(&'__b self, out: &mut Output<'__b, '_, __DB>) -> Result

See the trait documentation.

impl TryFrom<i32> for Page

type Error = TryFromPageError

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<i64> for Page

type Error = TryFromPageError

The type returned in the event of a conversion error.

fn try_from(value: i64) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u64> for Page

type Error = TryFromPageError

The type returned in the event of a conversion error.

fn try_from(value: u64) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<usize> for Page

type Error = TryFromPageError

The type returned in the event of a conversion error.

fn try_from(value: usize) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Page

impl DieselNewtype<BigInt> for Page

impl Eq for Page

impl StructuralPartialEq for Page