Struct ipmpsc::Sender

pub struct Sender { /* fields omitted */ }

Represents the sending end of an inter-process channel.

Methods

impl Sender

pub fn from_path(path: &str) -> Result<Sender, Error>

Creates a new Sender backed by a file with the specified name.

The file must already exist and have been initialized by a call to Receiver::temp_file or Receiver::from_path. Any number of senders may be created for a given receiver, allowing multiple processes to send messages simultaneously to that receiver.

When creating multiple Senders for a given Receiver in a single process, it is much more efficient to use a single from_path call and clone the resulting Sender than it is to make multiple calls to from_path.

pub fn send(&self, value: &impl Serialize) -> Result<(), Error>

Send the specified message, waiting for sufficient contiguous space to become available in the ring buffer if necessary.

The serialized size of the message must be greater than zero or else this method will return Err(Error::from(error::ZeroSizedMessage)). If the serialized size is greater than the ring buffer capacity, this method will return Err(Error::from(error::MessageTooLarge)).

pub fn send_when_empty(&self, value: &impl Serialize) -> Result<(), Error>

Send the specified message, waiting for the ring buffer to become completely empty first.

This method is appropriate for sending time-sensitive messages where buffering would introduce undesirable latency.

The serialized size of the message must be greater than zero or else this method will return Err(Error::from(error::ZeroSizedMessage)). If the serialized size is greater than the ring buffer capacity, this method will return Err(Error::from(error::MessageTooLarge)).

Trait Implementations

impl Sync for Sender

impl Send for Sender

impl Clone for Sender

fn clone(&self) -> Sender

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.