Struct IPCComm 

pub struct IPCComm { /* private fields */ }

Implementations

impl IPCComm

Simple length-prefixed Borsh-encoded messages

pub fn new(stream: UnixStream) -> Self

Consumes a unix stream for length-prefixed Borsh-encoded communication.

pub async fn new_with_identifier<I: BorshDeserialize>( stream: UnixStream, ) -> Result<(Self, I), Error>

Consumes a unix stream for length-prefixed Borsh-encoded communication.

Waits until type I is received, will error if the initial message couldn’t be decoded.

pub async fn send_msg<S: BorshSerialize>(&mut self, msg: S) -> Result<(), Error>

Adds the provided message to a queue for sending over the underlying connection, but does not wait until the message is actually sent

pub fn blocking_send_msg<S: BorshSerialize>( &mut self, msg: S, ) -> Result<(), Error>

Adds the provided message to a queue for sending over the underlying connection, but does not block until the message is actually sent

pub async fn recv_msg<R: BorshDeserialize>( &mut self, ) -> Result<Option<R>, Error>

Removes and parses a message received messages queue. If there are no pending messages, None is returned.

pub async fn until_recv_msg<R: BorshDeserialize>( &mut self, ) -> Result<Option<R>, Error>

Removes and parses a message received messages queue. If there are no pending messages, this function waits until there is one. If the underlying connection is closed before a message could be received, None is returned.

pub fn stopped(&self) -> bool

Checks if the underlying connection is closed

pub fn stop(&self)

Stops parsing received messages

pub async fn wait_until_stopped(self)

Waits until the read/write tasks are stopped

Trait Implementations

impl Debug for IPCComm

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

Formats the value using the given formatter.