Struct Client 

pub struct Client { /* private fields */ }

A cheap-to-clone, concurrency-safe client for a 3x-ui panel.

Implementations

impl Client

pub fn new(base_url: impl AsRef<str>) -> Result<Self>

Creates a cookie-session client with default settings.

Errors

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

pub fn builder(base_url: impl AsRef<str>) -> Result<ClientBuilder>

Starts configuring a client.

Errors

Returns Error::Configuration when base_url is not an HTTP(S) URL.

pub fn base_url(&self) -> &Url

Returns the normalized panel base URL.

pub fn authentication_kind(&self) -> AuthenticationKind

Returns the authentication mechanism for protected panel endpoints.

pub fn response_body_limit(&self) -> usize

Returns the configured maximum ordinary API response body size.

pub fn download_body_limit(&self) -> usize

Returns the configured maximum database/migration download size.

pub const fn auth(&self) -> AuthApi<'_>

Accesses login, logout, 2FA, and CSRF operations.

pub const fn inbounds(&self) -> InboundsApi<'_>

Accesses inbound management operations.

pub const fn clients(&self) -> ClientsApi<'_>

Accesses client and client-group management operations.

pub const fn server(&self) -> ServerApi<'_>

Accesses server status, Xray lifecycle, maintenance, and utility operations.

pub const fn settings(&self) -> SettingsApi<'_>

Accesses panel settings, credentials, notifications, and API tokens.

pub const fn xray_settings(&self) -> XraySettingsApi<'_>

Accesses Xray settings, integrations, tests, and outbound subscriptions.

pub const fn hosts(&self) -> HostsApi<'_>

Accesses per-inbound subscription host override operations.

pub const fn nodes(&self) -> NodesApi<'_>

Accesses remote node registration, health, discovery, and mTLS operations.

pub const fn panel(&self) -> PanelApi<'_>

Accesses panel-wide metadata and backup operations.

pub const fn events(&self) -> EventsApi<'_>

Accesses the authenticated real-time event stream.

pub const fn subscription_balancers(&self) -> SubscriptionBalancersApi<'_>

Accesses JSON-subscription balancer management operations.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.