Struct SubscriptionClient 

pub struct SubscriptionClient { /* private fields */ }

Public client for the separate 3x-ui subscription HTTP/HTTPS server.

This client intentionally has no panel authentication or cookie state. The subscription identifier embedded into every request path is redacted from SDK errors.

Implementations

impl SubscriptionClient

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

Creates a client using the default /sub/, /json/, and /clash/ paths below server_url.

Errors

Returns an error when the URL or HTTP-client configuration is invalid.

pub fn builder(server_url: impl AsRef<str>) -> Result<SubscriptionClientBuilder>

Starts configuring a standalone subscription client.

Errors

Returns an error when server_url is not an absolute HTTP(S) URL.

pub fn from_settings(settings: &SubscriptionSettings) -> Result<Self>

Creates a client from the absolute public URIs and fallback paths in a panel settings snapshot.

Errors

Returns an error when subURI is not an absolute HTTP(S) prefix or any configured URI/HTTP option is invalid.

pub const fn response_body_limit(&self) -> usize

Returns the configured maximum subscription response body size.

pub async fn raw( &self, subscription_id: &str, ) -> Result<SubscriptionResponse<SubscriptionDocument>>

Fetches the raw subscription body.

The body is base64 when the panel’s subEncrypt setting is enabled.

Errors

Returns an error for transport or unsuccessful HTTP status.

pub async fn html( &self, subscription_id: &str, ) -> Result<SubscriptionResponse<SubscriptionDocument>>

Fetches the browser HTML information page.

Errors

Returns an error for transport, unsuccessful HTTP status, or invalid UTF-8.

pub async fn info(&self, subscription_id: &str) -> Result<SubscriptionInfo>

Fetches the typed format=info status view without imported link data.

Errors

Returns an error for transport, unsuccessful HTTP status, or invalid JSON.

pub async fn info_with_metadata( &self, subscription_id: &str, ) -> Result<SubscriptionResponse<SubscriptionInfo>>

Fetches the typed information view together with common and HWID headers.

Prefer this method when device-limit state is relevant to the caller.

Errors

Returns an error for transport, unsuccessful HTTP status, or invalid JSON.

pub async fn json( &self, subscription_id: &str, ) -> Result<SubscriptionResponse<SubscriptionJson>>

Fetches and parses the Xray JSON subscription document.

The raw-download view is requested to avoid browser content negotiation.

Errors

Returns an error for transport, unsuccessful HTTP status, or invalid JSON.

pub async fn clash( &self, subscription_id: &str, ) -> Result<SubscriptionResponse<SubscriptionDocument>>

Fetches the Clash/Mihomo YAML subscription document.

The raw-download view is requested to avoid browser content negotiation.

Errors

Returns an error for transport, unsuccessful HTTP status, or invalid UTF-8.

pub async fn mihomo( &self, subscription_id: &str, ) -> Result<SubscriptionResponse<SubscriptionDocument>>

Fetches the Mihomo alias (/mihomo/), when enabled and not shadowed by a configured path.

Errors

Returns a configuration error when the alias is shadowed, or an error for transport, unsuccessful HTTP status, or invalid UTF-8.

pub async fn mihomo_metadata( &self, subscription_id: &str, ) -> Result<SubscriptionMetadata>

Retrieves response headers from the mihomo alias.

Errors

Returns a configuration error when the alias is shadowed, or an error for transport or unsuccessful HTTP status.

pub async fn clash_legacy( &self, subscription_id: &str, ) -> Result<SubscriptionResponse<SubscriptionDocument>>

Fetches the legacy Clash alias (/clash-legacy/), when enabled and not shadowed by a configured path.

Errors

Returns a configuration error when the alias is shadowed, or an error for transport, unsuccessful HTTP status, or invalid UTF-8.

pub async fn clash_legacy_metadata( &self, subscription_id: &str, ) -> Result<SubscriptionMetadata>

Retrieves response headers from the clash_legacy alias.

Errors

Returns a configuration error when the alias is shadowed, or an error for transport or unsuccessful HTTP status.

pub async fn hwid_status(&self, subscription_id: &str) -> Result<HwidSlotStatus>

Reads device-slot counts without registering or touching a device.

Errors

Returns an error for transport, unsuccessful HTTP status, or malformed JSON.

pub async fn hwid_status_metadata( &self, subscription_id: &str, ) -> Result<SubscriptionMetadata>

Checks the read-only HWID status route with HEAD.

Errors

Returns an error for transport or unsuccessful HTTP status.

pub async fn raw_metadata( &self, subscription_id: &str, ) -> Result<SubscriptionMetadata>

Executes HEAD against the raw subscription route.

Errors

Returns an error for transport or unsuccessful HTTP status.

pub async fn json_metadata( &self, subscription_id: &str, ) -> Result<SubscriptionMetadata>

Executes HEAD against the JSON subscription route.

Errors

Returns an error for transport or unsuccessful HTTP status.

pub async fn clash_metadata( &self, subscription_id: &str, ) -> Result<SubscriptionMetadata>

Executes HEAD against the Clash subscription route.

Errors

Returns an error for transport or unsuccessful HTTP status.

Trait Implementations

impl Clone for SubscriptionClient

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 SubscriptionClient

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

Formats the value using the given formatter.