Skip to main content

SubscriptionClientBuilder

xui_rs::subscription

Struct SubscriptionClientBuilder 

Source 
pub struct SubscriptionClientBuilder { /* private fields */ }
Expand description

Builder for a public standalone SubscriptionClient.

Implementations§

Source§

impl SubscriptionClientBuilder

Source

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

Sets the configured raw subscription path (default /sub/).

Source

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

Sets the configured JSON subscription path (default /json/).

Source

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

Sets the configured Clash subscription path (default /clash/).

Source

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

Sets the total timeout for one subscription request.

Source

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

Sets the timeout for establishing a connection.

Source

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

Accepts invalid TLS certificates for this subscription server.

This weakens transport security for credential-bearing documents and should only be used with an explicitly trusted self-signed deployment.

Source

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

Routes subscription HTTP requests through an explicit proxy.

Environment proxy variables are never consulted.

Source

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.

Source

pub fn no_proxy(self) -> Self

Removes a previously configured explicit proxy.

Source

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

Sets the maximum in-memory size of a subscription response body.

Both declared Content-Length and actually received chunked or decompressed bytes are checked.

Source

pub fn device(self, device: SubscriptionDevice) -> Self

Sends subscription-device headers used by 3x-ui’s optional HWID gate.

Source

pub fn no_device(self) -> Self

Removes previously configured subscription-device metadata.

Source

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

Builds the standalone client.

§Errors

Returns an error when a configured path or HTTP-client option is invalid.

Trait Implementations§

Source§

impl Debug for SubscriptionClientBuilder

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more