Struct df_st_api::api_objects::ApiPage

pub struct ApiPage<D> where
    D: ApiObject + Serialize + SchemaExample,  {
    pub max_page_size: u32,
    pub total_item_count: u32,
    pub page_start: u32,
    pub page_size: u32,
    pub page_nr: u32,
    pub order: Option<OrderTypes>,
    pub order_by: Option<String>,
    pub etag: String,
    pub links: ApiPageLinks,
    pub data: Vec<ApiItem<D>>,
    pub given_etag: String,
    pub base_url: String,
    pub server_max_page_size: u32,
}

A paged response from the API. The actual requested data can be found in the data object.

Fields

max_page_size: u32

The maximum amount of items in this response.

total_item_count: u32

The total amount of items. (across all pages) Note: id's usually start at 0 so if there are 10 total items the list id is 9. But id's can be missing so do not use this to calculate id's!

page_start: u32

The offset from the start of the database structure. This value takes the sorting of the page into account.

page_size: u32

The actual size of the response. (page_size<=max_page_size).

page_nr: u32

The number of the page. This value is page_nr = page_start/max_page_size

order: Option<OrderTypes>

Order of the page. "asc" = A-Z, "desc" = Z-A. This field is only present if an order is set.

order_by: Option<String>

Name of the field for what it is ordered by. This field is only present if an order_by is set.

etag: String

Tag to identify this version of the page. More info here. This tag can be used to improve caching. ETag is a Sha256 of the whole response (including links and other metadata, excluding the etag itself.).

links: ApiPageLinks

Links the various related items.

data: Vec<ApiItem<D>>

List of actual requested data.

given_etag: String

The etag given in the request.

base_url: String

Server base url. Not included in response.

server_max_page_size: u32

Maximum amount of items requested on a page. Set by server at startup, see config. Not included in response.

Implementations

impl<D> ApiPage<D> where
    D: ApiObject + Default + Serialize + SchemaExample, 

pub fn new(
    pagination: &ApiPagination,
    server_info: &State<'_, ServerInfo>
) -> Self

pub fn wrap(&mut self, list: Vec<D>) -> bool

Store the data in the object and construct links and calculate ETag. Return if true etag match with request tag.

pub fn get_db_order(&self) -> Option<OrderTypes>

Returns if the page should be sorted and in what order.

Trait Implementations

impl<D: Clone> Clone for ApiPage<D> where
    D: ApiObject + Serialize + SchemaExample, 

fn clone(&self) -> ApiPage<D>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<D: Debug> Debug for ApiPage<D> where
    D: ApiObject + Serialize + SchemaExample, 

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

Formats the value using the given formatter.

impl<D: Default> Default for ApiPage<D> where
    D: ApiObject + Serialize + SchemaExample, 

fn default() -> ApiPage<D>

Returns the "default value" for a type.

impl<'de, D> Deserialize<'de> for ApiPage<D> where
    D: ApiObject + Serialize + SchemaExample,
    D: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<D: JsonSchema> JsonSchema for ApiPage<D> where
    D: ApiObject + Serialize + SchemaExample, 

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl<D> SchemaExample for ApiPage<D> where
    D: SchemaExample + Serialize + ApiObject, 

fn example() -> Self

impl<D> Serialize for ApiPage<D> where
    D: ApiObject + Serialize + SchemaExample,
    D: Serialize, 

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

Serialize this value into the given Serde serializer.