Struct GraphqlOffsetPagination 

pub struct GraphqlOffsetPagination {
    pub type: OffsetPaginationKind,
    pub offset_variable: String,
    pub page_size: usize,
    pub stop_when_short: bool,
    pub substitute_in_query: bool,
}

Offset-into-query-variable pagination (ShopifyQL and similar).

Increments an integer offset injected into a GraphQL variable and terminates on a short page (fewer than page_size records) — unlike cursor pagination, which follows a pageInfo boolean. Suited to APIs whose query language embeds LIMIT … OFFSET … (e.g. ShopifyQL): bake the limit into the query string and parameterize only the offset with ${…}.

The offset starts at 0, is sent as a JSON number in the variables map on every request, and advances by page_size after each page.

Fields

type: OffsetPaginationKind

Discriminator — must be Offset.

offset_variable: String

Name of the GraphQL variable that receives the current offset. It is injected as a JSON number (starting at 0, incremented by page_size after each page). Reference it from the query string or as a variable (e.g. ${q_offset} for ShopifyQL).

page_size: usize

Records requested per page. Used both to advance the offset (offset += page_size) and, with stop_when_short, to detect the final page. Must be greater than 0. This value is not injected into the request — bake the limit into your query (LIMIT 250 OFFSET ${q_offset}).

stop_when_short: bool

Terminate when a page yields fewer than page_size records (default true). When false, pagination continues until a fully empty page (or max_pages) is reached.

substitute_in_query: bool

Substitute ${offset_variable} occurrences in the query string with the current offset before each request, instead of sending it as a GraphQL variable. Required for query languages that embed the offset in a string-literal argument — e.g. ShopifyQL’s shopifyqlQuery(query: "… LIMIT 250 OFFSET ${q_offset}"), where a GraphQL variable cannot interpolate into a string literal (#569). Default false (variable injection, the #550 behavior).

Trait Implementations

impl Clone for GraphqlOffsetPagination

fn clone(&self) -> GraphqlOffsetPagination

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GraphqlOffsetPagination

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GraphqlOffsetPagination

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for GraphqlOffsetPagination

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 Serialize for GraphqlOffsetPagination

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

where __S: Serializer,

Serialize this value into the given Serde serializer.