Struct ApiConfig 

pub struct ApiConfig {
    pub base_url: String,
    pub api_key: Option<SecretApiKey>,
    pub http: HttpClientConfig,
}

Generic API configuration

Provides common configuration options for all API clients:

• Base URL (validated to be HTTPS in production)
• API key (optional, redacted in Debug)
• HTTP client settings (timeout, proxy, user-agent)

Security

• API keys are wrapped in SecretApiKey to prevent accidental logging
• Use validate() to check that the base URL uses HTTPS

Fields

base_url: String

Base URL for the API

api_key: Option<SecretApiKey>

API key for authentication (optional, redacted in Debug)

http: HttpClientConfig

HTTP client configuration

Implementations

impl ApiConfig

pub fn new(base_url: impl Into<String>) -> ApiConfig

Create a new config with a base URL

pub fn with_api_key( base_url: impl Into<String>, api_key: impl Into<String>, ) -> ApiConfig

Create a new config with base URL and API key

pub fn api_key(self, key: impl Into<String>) -> ApiConfig

Set the API key

pub fn optional_api_key(self, key: Option<String>) -> ApiConfig

Set optional API key

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

Set request timeout

pub fn with_timeout_secs(self, secs: u64) -> ApiConfig

Set request timeout in seconds

pub fn proxy(self, proxy: impl Into<String>) -> ApiConfig

Set proxy URL

pub fn optional_proxy(self, proxy: Option<String>) -> ApiConfig

Set optional proxy URL

pub fn build_client(&self) -> Result<Client, HttpError>

Build an HTTP client from this configuration

pub fn validate(&self) -> Result<(), ConfigValidationError>

Validate the configuration for security.

Returns an error if:

• The base URL uses HTTP instead of HTTPS (security risk)
• The base URL is malformed

Example

use yldfi_common::api::ApiConfig;

// HTTPS URLs are valid
let config = ApiConfig::new("https://api.example.com");
assert!(config.validate().is_ok());

// HTTP URLs are rejected
let config = ApiConfig::new("http://api.example.com");
assert!(config.validate().is_err());

pub fn is_https(&self) -> bool

Check if the base URL uses HTTPS.

pub fn get_api_key(&self) -> Option<&str>

Get the exposed API key, if set.

Trait Implementations

impl Clone for ApiConfig

fn clone(&self) -> ApiConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiConfig

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

Formats the value using the given formatter.