Skip to main content

Client

Struct Client 

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

Client for the arcbox-helper privileged daemon.

Implementations§

Source§

impl Client

Source

pub async fn connect() -> Result<Self, ClientError>

Connects to the helper daemon via Unix socket.

Uses launchd-managed socket by default (/var/run/arcbox-helper.sock), overridable via ARCBOX_HELPER_SOCKET env var.

Source

pub async fn connect_to(path: &str) -> Result<Self, ClientError>

Connects to the helper daemon at an explicit socket path.

Unlike connect(), this does not read the ARCBOX_HELPER_SOCKET env var, making it safe for parallel tests.

Source

pub async fn route_add( &self, subnet: &str, iface: &str, ) -> Result<(), ClientError>

Adds a host route for subnet via iface.

Source

pub async fn route_remove(&self, subnet: &str) -> Result<(), ClientError>

Removes the host route for subnet.

Source

pub async fn dns_install( &self, domain: &str, port: u16, ) -> Result<(), ClientError>

Installs a DNS resolver file for domain on port port.

Source

pub async fn dns_uninstall(&self, domain: &str) -> Result<(), ClientError>

Removes the DNS resolver file for domain.

Source

pub async fn dns_status(&self, domain: &str) -> Result<bool, ClientError>

Checks if a DNS resolver file is installed for domain.

Source

pub async fn hosts_alias_install(&self) -> Result<(), ClientError>

Appends the fixed 127.0.0.1 ArcBox alias to /etc/hosts.

Source

pub async fn hosts_alias_uninstall(&self) -> Result<(), ClientError>

Removes the ArcBox alias line from /etc/hosts.

Source

pub async fn hosts_alias_status(&self) -> Result<bool, ClientError>

Checks whether the ArcBox /etc/hosts alias is installed.

Creates the /var/run/docker.socktarget symlink.

Removes the /var/run/docker.sock symlink.

Creates /usr/local/bin/{name}target symlink.

Removes /usr/local/bin/{name} symlink if ArcBox-owned.

Source

pub async fn version(&self) -> Result<String, ClientError>

Returns the helper daemon version.

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> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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