Struct GatewayEndpoint 

#[non_exhaustive]
pub struct GatewayEndpoint { /* private fields */ }

A validated base URL for the gateway’s OpenAI-compatible API (its /v1 root).

Construction requires an http or https scheme and a host, so a client always points at a usable endpoint. Any trailing slash is removed so request paths join cleanly.

Implementations

impl GatewayEndpoint

pub fn new(url: &str) -> Result<GatewayEndpoint, GatewayConfigError>

Validates and normalizes a gateway base URL.

The URL is checked with a strict URL parser.

Errors

Returns a GatewayConfigError when url fails to parse as an absolute URL, uses a scheme other than http or https, omits the host, embeds credentials (a user:pass@ component), or has a query or fragment. A query or fragment is rejected because an API root is a bare path. No error includes url, because a URL can contain a credential.

pub fn url(&self) -> &str

Returns the normalized base URL.

pub fn is_loopback(&self) -> bool

Returns whether the endpoint’s host is the local machine.

It returns true for localhost, for 127.0.0.1 and the rest of 127.0.0.0/8, and for ::1. It returns false for every other name or address. By default, a gateway on the local machine accepts callers that omit the key, so GatewayChat::from_env makes the bearer key optional exactly when this returns true.

Trait Implementations

impl Clone for GatewayEndpoint

fn clone(&self) -> GatewayEndpoint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GatewayEndpoint

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

Formats the value using the given formatter.

impl Eq for GatewayEndpoint

impl PartialEq for GatewayEndpoint

fn eq(&self, other: &GatewayEndpoint) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for GatewayEndpoint

impl TryFrom<&str> for GatewayEndpoint

type Error = GatewayConfigError

The type returned in the event of a conversion error.

fn try_from(url: &str) -> Result<GatewayEndpoint, GatewayConfigError>

Performs the conversion.