Struct PageQuery 

pub struct PageQuery {
    pub date_from: Option<DateTime>,
    pub date_to: Option<DateTime>,
    pub offset: Option<u64>,
    pub limit: Option<u64>,
}

Available on crate feature transport only.

The query parameters of a paginated GET.

date_from: Only return objects that have last_updated after or equal to this Date/Time (inclusive). date_to: … up to this Date/Time, but not including (exclusive).

The half-open interval is the point: “when sequential requests to the same end-point are done, the next interval will have no overlap and the date_from of the next interval is simply the date_to of the previous interval.” PageQuery::next_interval does that.

Spec: 2.3.0 §transport_and_format_paginated_request

Fields

date_from: Option<DateTime>

Only objects with last_updated at or after this time. Inclusive.

date_to: Option<DateTime>

Only objects with last_updated before this time. Exclusive.

offset: Option<u64>

The offset of the first object returned. Absent means 0.

limit: Option<u64>

The maximum number of objects to return. The server may return fewer.

Implementations

impl PageQuery

pub fn new() -> Self

An empty query: everything, from the beginning, at the server’s own page size.

pub fn since(from: DateTime) -> Self

Everything updated at or after from.

pub fn between(from: DateTime, to: DateTime) -> Self

Everything updated in [from, to).

pub fn with_limit(self, limit: u64) -> Self

This query with an explicit page size.

pub fn with_offset(self, offset: u64) -> Self

This query with an explicit offset.

pub fn offset_or_default(&self) -> u64

The offset, applying the spec’s default of 0.

pub fn next_interval(&self, new_end: DateTime) -> Option<Self>

The query for the next time interval, starting where this one ended.

Returns None when this query has no date_to to continue from.

pub fn to_query_string(&self) -> String

The query string, with the parameters in the order the spec’s examples use.

Returns an empty string when nothing is set, so it can be appended unconditionally.

pub fn apply_to(&self, base: &Url) -> Url

Applies this query to a base URL.

pub fn clamped_to(self, max: u64) -> Self

Clamps limit to max, as a peer’s advertised X-Limit requires.

Trait Implementations

impl Clone for PageQuery

fn clone(&self) -> PageQuery

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PageQuery

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

Formats the value using the given formatter.

impl Default for PageQuery

fn default() -> PageQuery

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PageQuery

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PageQuery

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

Formats the value using the given formatter.

impl Eq for PageQuery

impl JsonSchema for PageQuery

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

The name of the generated JSON Schema.

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

Returns a string that uniquely identifies the schema produced by this type.

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

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for PageQuery

fn eq(&self, other: &PageQuery) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for PageQuery

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PageQuery