Struct GraphqlPagination 

pub struct GraphqlPagination {
    pub has_next_page_path: String,
    pub cursor_path: String,
    pub cursor_variable: String,
    pub page_size_variable: String,
}

Available on crate features source-graphql and source-rest only.

Cursor-based pagination configuration for GraphQL.

Most GraphQL APIs use the Relay cursor specification with pageInfo { hasNextPage, endCursor }.

Fields

has_next_page_path: String

JSONPath to the hasNextPage boolean in the response.

cursor_path: String

JSONPath to the endCursor string in the response.

cursor_variable: String

Name of the cursor variable in the GraphQL query (default: "after").

page_size_variable: String

Name of the page size variable (default: "first").

The per-page record count itself comes from GraphqlStreamConfig::batch_size — the variable named here is the GraphQL variable that the batch_size value is injected into on each request. The plain batch_size = 0 sentinel omits the variable so the upstream uses its own default page size.

Trait Implementations

impl Clone for GraphqlPagination

fn clone(&self) -> GraphqlPagination

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GraphqlPagination

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

Formats the value using the given formatter.

impl Default for GraphqlPagination

fn default() -> GraphqlPagination

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GraphqlPagination

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for GraphqlPagination

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 GraphqlPagination

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

where __S: Serializer,

Serialize this value into the given Serde serializer.