Struct BaseClient 

pub struct BaseClient { /* private fields */ }

A base HTTP client that handles common request/response patterns.

This client provides reusable methods for making GET and POST requests with proper error handling, reducing boilerplate across API crates.

Example

use yldfi_common::api::{ApiConfig, BaseClient};

// Create a client with configuration
let config = ApiConfig::new("https://api.example.com")
    .api_key("your-api-key");
let client = BaseClient::new(config).unwrap();

// Build URLs
assert_eq!(client.url("/quote"), "https://api.example.com/quote");

// Access config
assert_eq!(client.config().get_api_key(), Some("your-api-key"));

Implementations

impl BaseClient

pub fn new(config: ApiConfig) -> Result<BaseClient, HttpError>

Create a new base client from configuration.

Errors

Returns an error if the HTTP client cannot be built.

pub fn http(&self) -> &Client

Get the underlying HTTP client.

pub fn config(&self) -> &ApiConfig

Get the configuration.

pub fn base_url(&self) -> &str

Get the base URL.

pub fn url(&self, path: &str) -> String

Build the full URL for a path.

pub fn default_headers(&self) -> HeaderMap

Build default headers with API key (if present).

Override this in your client to add custom headers.

pub async fn get<T, E>( &self, path: &str, params: &[(&str, impl AsRef<str>)], ) -> Result<T, ApiError<E>>

where T: DeserializeOwned, E: Error,

Make a GET request with query parameters.

Type Parameters

• T - The response type (must implement DeserializeOwned)
• E - Domain-specific error type (default: NoDomainError)

Arguments

• path - The API path (will be joined with base_url)
• params - Query parameters as key-value pairs

pub async fn get_with_headers<T, E>( &self, path: &str, params: &[(&str, impl AsRef<str>)], headers: HeaderMap, ) -> Result<T, ApiError<E>>

where T: DeserializeOwned, E: Error,

Make a GET request with custom headers.

Use this when you need to add API-specific headers beyond the default Authorization header.

pub async fn post_json<T, B, E>( &self, path: &str, body: &B, ) -> Result<T, ApiError<E>>

where T: DeserializeOwned, B: Serialize, E: Error,

Make a POST request with JSON body.

Type Parameters

• T - The response type
• B - The request body type (must implement Serialize)
• E - Domain-specific error type

pub async fn post_json_with_headers<T, B, E>( &self, path: &str, body: &B, headers: HeaderMap, ) -> Result<T, ApiError<E>>

where T: DeserializeOwned, B: Serialize, E: Error,

Make a POST request with JSON body and custom headers.

pub async fn post_form<T, E>( &self, path: &str, form: &[(&str, impl AsRef<str>)], ) -> Result<T, ApiError<E>>

where T: DeserializeOwned, E: Error,

Make a POST request with form data.

Trait Implementations

impl Clone for BaseClient

fn clone(&self) -> BaseClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BaseClient

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

Formats the value using the given formatter.