Struct dropshot::ResultsPage

pub struct ResultsPage<ItemType> {
    pub next_page: Option<String>,
    pub items: Vec<ItemType>,
}

A page of results from a paginated API

This structure is intended for use both on the server side (to generate the results page) and on the client side (to parse it).

Fields

next_page: Option<String>

token used to fetch the next page of results (if any)

items: Vec<ItemType>

list of items on this page of results

Implementations

impl<ItemType> ResultsPage<ItemType>

pub fn new<F, ScanParams, PageSelector>(
    items: Vec<ItemType>,
    scan_params: &ScanParams,
    get_page_selector: F
) -> Result<ResultsPage<ItemType>, HttpError> where
    F: Fn(&ItemType, &ScanParams) -> PageSelector,
    PageSelector: Serialize, 

Construct a new results page from the list of items. page_selector is a function used to construct the page token that clients will provide to fetch the next page of results. scan_params is provided to the page_selector function, since the token may depend on the type of scan.

Trait Implementations

impl<ItemType: Debug> Debug for ResultsPage<ItemType>

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

Formats the value using the given formatter.

impl<'de, ItemType> Deserialize<'de> for ResultsPage<ItemType> where
    ItemType: Deserialize<'de>, 

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

Deserialize this value from the given Serde deserializer.

impl<ItemType: JsonSchema> JsonSchema for ResultsPage<ItemType>

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<ItemType> Serialize for ResultsPage<ItemType> where
    ItemType: Serialize, 

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

Serialize this value into the given Serde serializer.