Struct dropshot::PaginationParams

pub struct PaginationParams<ScanParams, PageSelector> where
    ScanParams: DeserializeOwned,
    PageSelector: DeserializeOwned + Serialize,  {
    pub page: WhichPage<ScanParams, PageSelector>,
    // some fields omitted
}

Querystring parameters provided by clients when scanning a paginated collection

To build an API endpoint that paginates results, you have your handler function accept a Query<PaginationParams<ScanParams, PageSelector>> and return a ResultsPage. You define your own ScanParams and PageSelector types.

ScanParams describes the set of querystring parameters that your endpoint accepts for the first request of the scan (typically: filters and sort options). This must be deserializable from a querystring.

PageSelector describes the information your endpoint needs for requests after the first one. Typically this would include an id of some sort for the last item on the previous page as well as any parameters related to filtering or sorting so that your function can apply those, too. The entire PageSelector will be serialized to an opaque string and included in the ResultsPage. The client is expected to provide this string as the "page_token" querystring parameter in the subsequent request. PageSelector must implement both Deserialize and Serialize. (Unlike ScanParams, PageSelector will not be deserialized directly from the querystring.)

There are several complete, documented examples in dropshot/examples.

NOTE: Your choices of ScanParams and PageSelector determine the querystring parameters accepted by your endpoint and the structure of the page token, respectively. Both of these are part of your API's public interface, though the page token won't appear in the OpenAPI spec. Be careful when designing these structures to consider what you might want to support in the future.

Fields

page: WhichPage<ScanParams, PageSelector>

Specifies whether this is the first request in a scan or a subsequent request, as well as the parameters provided

See WhichPage for details. Note that this field is flattened by serde, so you have to look at the variants of WhichPage to see what query parameters are actually processed here.

Trait Implementations

impl<ScanParams: Debug, PageSelector: Debug> Debug for PaginationParams<ScanParams, PageSelector> where
    ScanParams: DeserializeOwned,
    PageSelector: DeserializeOwned + Serialize, 

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

Formats the value using the given formatter.

impl<'de, ScanParams, PageSelector> Deserialize<'de> for PaginationParams<ScanParams, PageSelector> where
    ScanParams: DeserializeOwned,
    PageSelector: DeserializeOwned + Serialize, 

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

Deserialize this value from the given Serde deserializer.

impl<ScanParams: JsonSchema, PageSelector: JsonSchema> JsonSchema for PaginationParams<ScanParams, PageSelector> where
    ScanParams: DeserializeOwned,
    PageSelector: DeserializeOwned + Serialize, 

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.