Struct CursorPage 

pub struct CursorPage<T: Serialize + ApiSchema, C: Serialize + ApiSchema> {
    pub items: Vec<T>,
    pub total: u64,
    pub limit: u64,
    pub next_cursor: Option<C>,
}

Serialized cursor 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.

next_cursor: Option<C>

Cursor that can be sent back to fetch the next page.

Implementations

impl<T: Serialize + ApiSchema, C: Serialize + ApiSchema> CursorPage<T, C>

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

Creates a new cursor page.

Trait Implementations

impl<T: Clone + Serialize + ApiSchema, C: Clone + Serialize + ApiSchema> Clone for CursorPage<T, C>

fn clone(&self) -> CursorPage<T, C>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T, C> ComposeSchema for CursorPage<T, C>

where T: ToSchema + Serialize + ApiSchema, C: ToSchema + Serialize + ApiSchema,

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

impl<T: Debug + Serialize + ApiSchema, C: Debug + Serialize + ApiSchema> Debug for CursorPage<T, C>

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

Formats the value using the given formatter.

impl<T, C> Serialize for CursorPage<T, C>

where T: Serialize + Serialize + ApiSchema, C: Serialize + Serialize + ApiSchema,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T, C> ToSchema for CursorPage<T, C>

where T: ToSchema + Serialize + ApiSchema, C: ToSchema + Serialize + ApiSchema,

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

Return name of the schema.

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

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