Struct APIContextOptions 

pub struct APIContextOptions { /* private fields */ }

Options for creating an API request context.

Example

use viewpoint_core::api::APIContextOptions;
use std::time::Duration;

let options = APIContextOptions::new()
    .base_url("https://api.example.com")
    .timeout(Duration::from_secs(30))
    .extra_http_headers([
        ("Authorization".to_string(), "Bearer token".to_string()),
    ]);

Implementations

impl APIContextOptions

pub fn new() -> Self

Create a new options builder with default settings.

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

Set the base URL for all requests.

Relative URLs passed to request methods will be resolved against this base URL.

Example

use viewpoint_core::api::APIContextOptions;

let options = APIContextOptions::new()
    .base_url("https://api.example.com/v1");
// Now api.get("/users") will request https://api.example.com/v1/users

pub fn extra_http_headers( self, headers: impl IntoIterator<Item = (String, String)>, ) -> Self

Set extra HTTP headers to include in all requests.

Example

use viewpoint_core::api::APIContextOptions;

let options = APIContextOptions::new()
    .extra_http_headers([
        ("Authorization".to_string(), "Bearer token".to_string()),
        ("X-API-Key".to_string(), "secret".to_string()),
    ]);

pub fn header(self, name: impl Into<String>, value: impl Into<String>) -> Self

Add a single extra HTTP header.

pub fn http_credentials(self, credentials: HttpCredentials) -> Self

Set HTTP credentials for Basic authentication.

Example

use viewpoint_core::api::{APIContextOptions, HttpCredentials};

let options = APIContextOptions::new()
    .http_credentials(HttpCredentials::new("user", "pass"));

pub fn ignore_https_errors(self, ignore: bool) -> Self

Set whether to ignore HTTPS certificate errors.

Warning: This should only be used for testing. Never use this in production as it makes the connection vulnerable to man-in-the-middle attacks.

pub fn proxy(self, proxy: ProxyConfig) -> Self

Set proxy configuration.

Example

use viewpoint_core::api::{APIContextOptions, ProxyConfig};

let options = APIContextOptions::new()
    .proxy(ProxyConfig::new("http://proxy.example.com:8080")
        .credentials("user", "pass"));

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

Set the default timeout for all requests.

This can be overridden on a per-request basis.

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

Set the user agent string.

Trait Implementations

impl Clone for APIContextOptions

fn clone(&self) -> APIContextOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for APIContextOptions

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

Formats the value using the given formatter.

impl Default for APIContextOptions

fn default() -> APIContextOptions

Returns the “default value” for a type.