Skip to main content

PaginationConfig

Enum PaginationConfig 

Source
pub enum PaginationConfig {
    OffsetLimit {
        offset_param: String,
        limit_param: String,
        page_size: u64,
        total_path: Option<String>,
    },
    PageNumber {
        page_param: String,
        page_size_param: String,
        page_size: u64,
        total_pages_path: Option<String>,
    },
    Cursor {
        cursor_param: String,
        cursor_path: String,
        has_more_path: Option<String>,
        page_size_param: Option<String>,
        page_size: Option<u64>,
    },
    LinkHeader {
        page_size_param: Option<String>,
        page_size: Option<u64>,
    },
    NextUrl {
        next_url_path: String,
        base_url: Option<String>,
    },
}
Expand description

Pagination configuration.

Variants§

§

OffsetLimit

Offset/limit pagination.

Fields

§offset_param: String

Query parameter name for offset (default: “offset”).

§limit_param: String

Query parameter name for limit/page size (default: “limit”).

§page_size: u64

Number of items per page.

§total_path: Option<String>

JSONPath to extract total count from response (optional).

§

PageNumber

Page number pagination.

Fields

§page_param: String

Query parameter name for page number (default: “page”).

§page_size_param: String

Query parameter name for page size (default: “per_page”).

§page_size: u64

Number of items per page.

§total_pages_path: Option<String>

JSONPath to extract total pages from response (optional).

§

Cursor

Cursor-based pagination (e.g., Stripe’s starting_after).

Fields

§cursor_param: String

Query parameter name to send the cursor value.

§cursor_path: String

JSONPath to extract the next cursor value from the response.

§has_more_path: Option<String>

JSONPath to a boolean has_more field (optional).

§page_size_param: Option<String>

Query parameter name for page size (optional).

§page_size: Option<u64>

Number of items per page (optional).

§

LinkHeader

Link header pagination (RFC 5988).

Fields

§page_size_param: Option<String>

Query parameter name for page size (optional).

§page_size: Option<u64>

Number of items per page (optional).

§

NextUrl

Next URL from response body (e.g., Salesforce nextRecordsUrl).

Fields

§next_url_path: String

JSONPath to extract the next URL from the response body.

§base_url: Option<String>

Base URL to prepend if the extracted URL is relative.

Trait Implementations§

Source§

impl Clone for PaginationConfig

Source§

fn clone(&self) -> PaginationConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PaginationConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for PaginationConfig

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for PaginationConfig

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for PaginationConfig

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for PaginationConfig

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,