Struct ClientBuilder 

pub struct ClientBuilder { /* private fields */ }

Builder for Client.

Implementations

impl ClientBuilder

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

Uses a 3x-ui API token for protected API endpoints.

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

Sets the total timeout for one HTTP request.

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

Sets the timeout for establishing a connection.

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

Overrides the user-agent sent by the SDK.

pub const fn danger_accept_invalid_certs(self, accept: bool) -> Self

Accepts invalid TLS certificates.

Use this only for an explicitly trusted self-signed deployment. It weakens transport security for every request made by this client.

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

Routes panel HTTP requests and WebSocket connections through an explicit proxy.

Environment proxy variables are never consulted. Use ProxyScheme::Socks5h when target DNS resolution must happen on the proxy.

pub fn proxy_url(self, proxy_url: impl AsRef<str>) -> Result<Self>

Parses and configures a credential-free proxy URL.

Errors

Returns Error::Configuration for an invalid proxy URL. Configure credentials with ProxyConfig::with_basic_auth and Self::proxy.

pub fn no_proxy(self) -> Self

Removes a previously configured explicit proxy.

pub const fn response_body_limit(self, limit: usize) -> Self

Sets the maximum in-memory size of an ordinary panel API response.

Both declared Content-Length and actually received chunked or decompressed bytes are checked. Set a deliberately larger value for deployments whose client lists, logs, or runtime OpenAPI exceed the safe 64 MiB default.

pub const fn download_body_limit(self, limit: usize) -> Self

Sets the maximum in-memory size of explicit database and migration downloads.

This is separate from Self::response_body_limit because backups are expected to be substantially larger than structured API responses.

pub fn build(self) -> Result<Client>

Builds the configured client.

Errors

Returns Error::Configuration when the HTTP client configuration is invalid.

Trait Implementations

impl Debug for ClientBuilder

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

Formats the value using the given formatter.