Skip to main content

IpcClient

Struct IpcClient 

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

Client for communicating with a running super::IpcServer.

Uses Unix domain sockets on Linux/macOS and named pipes on Windows. Each method opens a fresh connection for the duration of the call.

§Examples

let client = IpcClient::default();

if client.is_running().await {
    let response = client.send(IpcRequest::List).await?;
    println!("{response:?}");
}

Implementations§

Source§

impl IpcClient

Source

pub fn with_path(path: impl Into<String>) -> Self

Create a client targeting a custom socket path.

Prefer IpcClient::default in production code. This method exists primarily for test isolation.

Source

pub async fn is_running(&self) -> bool

Return true if a daemon is reachable on the configured socket.

This is a lightweight connection probe — no request is sent.

Source

pub async fn send(&self, request: IpcRequest) -> Result<IpcResponse>

Send a single request to the daemon and await its response.

Opens a connection, writes the request as a newline-terminated JSON object, reads one response line, then closes the connection.

§Errors

Returns IpcError if the connection fails, the daemon is not running, or serialization of the request or response fails.

Source

pub async fn subscribe(&self) -> Result<Receiver<DnsEvent>>

Subscribe to daemon events and receive them through an async channel.

Connects to the daemon, sends a IpcRequest::Subscribe command, and immediately returns a mpsc::Receiver that yields DnsEvent values as they arrive. The background task exits when the connection is closed.

Dropping the returned receiver causes the background task to exit on the next event delivery attempt.

§Errors

Returns IpcError if the initial connection or subscribe handshake fails.

Trait Implementations§

Source§

impl Default for IpcClient

Source§

fn default() -> Self

Returns the “default value” for a type. 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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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