Struct RestApiBuilder 

pub struct RestApiBuilder { /* private fields */ }

Builder for RestApi. Lets callers pick a ResponseShape and override the pagination parameter names.

use vantage_api_client::{RestApi, ResponseShape, PaginationParams};

// JSONPlaceholder: bare arrays, JSON-Server pagination conventions.
let api = RestApi::builder("https://jsonplaceholder.typicode.com")
    .response_shape(ResponseShape::BareArray)
    .build();

// DummyJSON: wrapped-by-table-name, skip-based pagination.
let api = RestApi::builder("https://dummyjson.com")
    .response_shape(ResponseShape::WrappedByTableName)
    .pagination_params(PaginationParams::skip_limit("skip", "limit"))
    .build();

Implementations

impl RestApiBuilder

pub fn auth(self, auth: impl Into<String>) -> Self

Set the Authorization header value (e.g. “Bearer <token>”).

pub fn response_shape(self, shape: ResponseShape) -> Self

Choose how the API wraps its row array. Defaults to Wrapped { array_key: "data" } for backwards compat.

pub fn pagination_params(self, pagination: PaginationParams) -> Self

Override the page/limit query parameter names. Default is ("_page", "_limit") (JSON Server convention).

pub fn no_pagination(self) -> Self

Disable pagination entirely — no _page/_limit query params are appended, and a request for page > 1 is short- circuited to an empty result. Use this for APIs that don’t paginate (return the full list every call) or that treat unknown query params as strict filters.

pub fn filter_strategy(self, strategy: FilterStrategy) -> Self

Choose how non-path eq-conditions are applied. Default is FilterStrategy::Query; use FilterStrategy::Client for APIs that only filter via path segments and reject/ignore unknown query params (the conditions are then applied in memory).

pub fn build(self) -> RestApi

Trait Implementations

impl Clone for RestApiBuilder

fn clone(&self) -> RestApiBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RestApiBuilder

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

Formats the value using the given formatter.