Skip to main content

OffsetPage

Struct OffsetPage 

Source
pub struct OffsetPage<T: Serialize + ApiSchema> {
    pub items: Vec<T>,
    pub total: u64,
    pub limit: u64,
    pub offset: u64,
}
Expand description

Serialized offset page response.

Fields§

§items: Vec<T>

Items in the current page.

§total: u64

Total number of items matching the query.

§limit: u64

Effective page size.

§offset: u64

Offset used for this page.

Implementations§

Source§

impl<T: Serialize + ApiSchema> OffsetPage<T>

Source

pub fn new(items: Vec<T>, total: u64, limit: u64, offset: u64) -> Self

Creates a new offset page.

Trait Implementations§

Source§

impl<T: Clone + Serialize + ApiSchema> Clone for OffsetPage<T>

Source§

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

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T> ComposeSchema for OffsetPage<T>
where T: ToSchema + Serialize + ApiSchema,

Source§

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

Source§

impl<T: Debug + Serialize + ApiSchema> Debug for OffsetPage<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T> Serialize for OffsetPage<T>
where T: Serialize + Serialize + ApiSchema,

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl<T> ToSchema for OffsetPage<T>
where T: ToSchema + Serialize + ApiSchema,

Source§

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

Return name of the schema. Read more
Source§

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

Implement reference [utoipa::openapi::schema::Schema]s for this type. Read more

Auto Trait Implementations§

§

impl<T> Freeze for OffsetPage<T>

§

impl<T> RefUnwindSafe for OffsetPage<T>
where T: RefUnwindSafe,

§

impl<T> Send for OffsetPage<T>
where T: Send,

§

impl<T> Sync for OffsetPage<T>
where T: Sync,

§

impl<T> Unpin for OffsetPage<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for OffsetPage<T>

§

impl<T> UnwindSafe for OffsetPage<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> PartialSchema for T
where T: ComposeSchema + ?Sized,

§

fn schema() -> RefOr<Schema>

Return ref or schema of implementing type that can then be used to construct combined schemas.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.