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 max_parallel(self, n: usize) -> Self

Concurrent requests to this API at most (default 4).

pub fn rate_limit(self, per_second: f64) -> Self

Requests per second to this API at most.

pub fn request_timeout(self, timeout: Duration) -> Self

Give up on one request after timeout (default 30 s). Ignored when a client is supplied with http_client.

pub fn no_request_timeout(self) -> Self

Never time a request out. Ignored when a client is supplied.

pub fn observer( self, key: impl Into<Arc<str>>, observer: Arc<dyn TransportObserver>, ) -> Self

Report every attempt, retry and breaker transition under key (the datasource name).

pub fn http_client(self, client: Client) -> Self

A pre-configured reqwest::Client (timeouts, proxies, TLS).

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

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

pub fn auth_refresher(self, refresher: AuthRefresher) -> Self

Get the bearer token from refresher instead of a fixed header: it is asked on the first request, and again when the API answers 401. A request waits for it, so a refresher may run an interactive sign-in. Replaces auth.

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 total_key(self, key: impl Into<String>) -> Self

Name the response-envelope key carrying the grand total of matching rows (e.g. count). Setting it lets the shell report an exact count, advertise the Window capability for lazy/scroll loading, and put the total on every fetched page.

pub fn ordering(self, ordering: OrderingParams) -> Self

The API’s sort query param (see OrderingParams). With it set the vista advertises the Order capability and every column is orderable.

pub fn debug(self, debug: bool) -> Self

Emit tracing events for window/count requests.

pub fn build(self) -> RestApi

Finish the configuration. Builds no HTTP client yet: unless one was given with http_client, the default client is created on the first request.

Trait Implementations

impl Clone for RestApiBuilder

fn clone(&self) -> Self

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.