Skip to main content

SingBoxBackendOptions

Struct SingBoxBackendOptions 

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

Already-resolved host inputs for one sing-box backend.

The driver never resolves product paths: the host supplies the installed binary, the active profile document, the stable Core instance identity and the loopback Clash API coordinates that the profile declares.

Implementations§

Source§

impl SingBoxBackendOptions

Source

pub fn new( binary_path: impl Into<PathBuf>, config_path: impl Into<PathBuf>, instance_id: CoreInstanceId, controller_endpoint: impl Into<String>, secret: Option<String>, ) -> Result<Self, PortError>

Validates the host inputs with the default readiness bound.

Source

pub fn with_readiness_timeout( binary_path: impl Into<PathBuf>, config_path: impl Into<PathBuf>, instance_id: CoreInstanceId, controller_endpoint: impl Into<String>, secret: Option<String>, readiness_timeout: Duration, ) -> Result<Self, PortError>

Validates the host inputs together with an explicit readiness bound.

Source

pub fn binary_path(&self) -> &PathBuf

Returns the path of the sing-box binary the host may launch.

Source

pub fn config_path(&self) -> &PathBuf

Returns the path of the configuration file the core reads.

Source

pub fn instance_id(&self) -> &CoreInstanceId

Returns the configured instance identity of the core.

Source

pub fn controller_address(&self) -> SocketAddr

Returns the socket address the controller binds to.

Source

pub fn controller_endpoint(&self) -> String

Returns the explicit HTTP loopback endpoint of the controller.

Source

pub const fn readiness_timeout(&self) -> Duration

Bound the host applies while waiting for Clash API readiness after it explicitly starts the Core. Bundle creation never waits.

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> 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, 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