Struct ipmpsc::Receiver

pub struct Receiver { /* fields omitted */ }

Represents the receiving end of an inter-process channel, capable of receiving any message type implementing serde::Deserialize.

Methods

impl Receiver

pub fn from_path(path: &str, size_in_bytes: u32) -> Result<Receiver, Error>

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

The file will be created if it does not already exist or truncated otherwise. Once this method has returned successfully, any number of senders may be created using the Sender::from_path method.

pub fn temp_file(size_in_bytes: u32) -> Result<(String, Receiver), Error>

Creates a new Receiver backed by a temporary file which will be deleted when the Receiver is dropped.

The name of the file is returned along with the Receiver and may be used to create one or more corresponding senders using the Sender::from_path method.

pub fn try_recv<T>(&self) -> Result<Option<T>, Error> where
    T: for<'de> Deserialize<'de>, 

Attempt to read a message without blocking.

This will return Ok(None) if there are no messages immediately available.

pub fn recv<T>(&self) -> Result<T, Error> where
    T: for<'de> Deserialize<'de>, 

Attempt to read a message, blocking if necessary until one becomes available.

pub fn recv_timeout<T>(&self, timeout: Duration) -> Result<Option<T>, Error> where
    T: for<'de> Deserialize<'de>, 

Attempt to read a message, blocking for up to the specified duration if necessary until one becomes available.

pub fn zero_copy_context(&mut self) -> ZeroCopyContext

Borrows this receiver for deserializing a message with references that refer directly to this Receiver's ring buffer rather than copying out of it.

Because those references refer directly to the ring buffer, the read pointer cannot be advanced until the lifetime of those references ends.

To ensure the above, the following rules apply:

1. The underlying Receiver cannot be used while a ZeroCopyContext borrows it (enforced at compile time).

2. References in a message deserialized using a given ZeroCopyContext cannot outlive that instance (enforced at compile time).

3. A given ZeroCopyContext can only be used to deserialize a single message before it must be discarded since the read pointer is advanced only when the instance is dropped (enforced at run time).