Skip to main content

Ipc

Struct Ipc 

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

An IPC (Inter-Process Communication) implementation using Unix domain sockets.

This struct represents the IPC transport, which allows communication between processes on the same machine using Unix domain sockets.

§Features

  • Asynchronous communication using Tokio’s runtime
  • Supports both connection-oriented (stream) and connectionless (datagram) sockets
  • Implements standard transport traits for easy integration with other components

Note: This implementation is specific to Unix-like operating systems and is not tested on Windows or other non-Unix platforms.

Implementations§

Source§

impl Ipc

Source

pub fn new(config: Config) -> Self

Creates a new Ipc transport.

Trait Implementations§

Source§

impl Debug for Ipc

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Ipc

Source§

fn default() -> Ipc

Returns the “default value” for a type. Read more
Source§

impl Transport<PathBuf> for Ipc

Source§

type Stats = ()

The statistics for the transport (specifically its underlying IO object).
Source§

type Io = IpcStream

The result of a successful connection. Read more
Source§

type Control = ()

Control-plane messages that modify the runtime behavior of the transport.
Source§

type Error = Error

An error that occurred when setting up the connection.
Source§

type Connect = Pin<Box<dyn Future<Output = Result<<Ipc as Transport<PathBuf>>::Io, <Ipc as Transport<PathBuf>>::Error>> + Send>>

A pending output for an outbound connection, obtained when calling Transport::connect.
Source§

type Accept = Pin<Box<dyn Future<Output = Result<<Ipc as Transport<PathBuf>>::Io, <Ipc as Transport<PathBuf>>::Error>> + Send>>

A pending output for an inbound connection, obtained when calling Transport::poll_accept.
Source§

fn local_addr(&self) -> Option<PathBuf>

Returns the local address this transport is bound to (if it is bound).
Source§

fn bind<'life0, 'async_trait>( &'life0 mut self, addr: PathBuf, ) -> Pin<Box<dyn Future<Output = Result<(), Self::Error>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Binds to the given address.
Source§

fn connect(&mut self, addr: PathBuf) -> Self::Connect

Connects to the given address, returning a future representing a pending outbound connection.
Source§

fn poll_accept(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Accept>

Poll for incoming connections. If an inbound connection is received, a future representing a pending inbound connection is returned. The future will resolve to Transport::Accept.
Source§

fn on_control(&mut self, _ctrl: Self::Control)

Applies a control-plane message to the transport. It is expected to update internal state only and should not perform long-running operations.
Source§

impl TransportExt<PathBuf> for Ipc

Source§

fn accept(&mut self) -> Acceptor<'_, Self, PathBuf>
where Self: Sized + Unpin,

Async-friendly interface for accepting inbound connections.

Auto Trait Implementations§

§

impl !Freeze for Ipc

§

impl RefUnwindSafe for Ipc

§

impl Send for Ipc

§

impl Sync for Ipc

§

impl Unpin for Ipc

§

impl UnsafeUnpin for Ipc

§

impl UnwindSafe for Ipc

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

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