Struct OpenAiCompatEnvironmentImpl 

pub struct OpenAiCompatEnvironmentImpl { /* private fields */ }

Environment configuration trait and default implementation. Environment configuration trait and default implementation. Default OpenAI-compatible environment backed by in-memory values.

Construct with new(), then chain builder methods to override defaults.

Examples

use api_openai_compatible::OpenAiCompatEnvironmentImpl;

let env = OpenAiCompatEnvironmentImpl::new( "sk-..." ).unwrap();
// override base URL for a KIE.ai model slug:
let kie_env = env.with_base_url( "https://api.kie.ai/my-model/v1/" );

Implementations

impl OpenAiCompatEnvironmentImpl

pub const DEFAULT_BASE_URL: &'static str = "https://api.openai.com/v1/"

Default base URL for the OpenAI API.

pub const DEFAULT_TIMEOUT_SECS: u64 = 30

Default request timeout in seconds.

pub fn new(api_key: impl Into<String>) -> Result<Self>

Creates a new environment with default base URL and 30-second timeout.

Arguments

• api_key — API authentication key. May be any Into<String>.

Errors

Returns an error if api_key is empty or otherwise invalid.

Examples

use api_openai_compatible::OpenAiCompatEnvironmentImpl;

let env = OpenAiCompatEnvironmentImpl::new( "sk-mykey" ).unwrap();

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

Overrides the base URL, returning the modified environment.

Use this to target non-standard endpoints such as KIE.ai model-slug URLs ("https://api.kie.ai/{slug}/v1/") or local development proxies.

Examples

use api_openai_compatible::OpenAiCompatEnvironmentImpl;

let env = OpenAiCompatEnvironmentImpl::new( "sk-key" ).unwrap()
  .with_base_url( "https://api.kie.ai/gpt-4o/v1/" );

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

Overrides the request timeout, returning the modified environment.

Examples

use api_openai_compatible::OpenAiCompatEnvironmentImpl;
use core::time::Duration;

let env = OpenAiCompatEnvironmentImpl::new( "sk-key" ).unwrap()
  .with_timeout( Duration::from_secs( 60 ) );

Trait Implementations

impl Clone for OpenAiCompatEnvironmentImpl

fn clone(&self) -> OpenAiCompatEnvironmentImpl

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenAiCompatEnvironmentImpl

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

Formats the value using the given formatter.

impl OpenAiCompatEnvironment for OpenAiCompatEnvironmentImpl

fn api_key(&self) -> &str

Returns the raw API key string.

fn base_url(&self) -> &str

Returns the base URL for this provider, including the trailing slash.

fn timeout(&self) -> Duration

Returns the per-request timeout duration.

fn headers(&self) -> Result<HeaderMap>

Constructs the HTTP headers required for every request.