Struct ipmpsc::SharedRingBuffer

pub struct SharedRingBuffer { /* fields omitted */ }

Represents a file-backed shared memory ring buffer, suitable for constructing a Receiver or Sender.

Note that it is possible to create multiple SharedRingBuffers for a given path in a single process, but it is much more efficient to clone an exisiting instance than construct one from scratch using one of the constructors.

Methods

impl SharedRingBuffer

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

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

The file will be created if it does not already exist or truncated otherwise.

Once this function completes successfully, the same path may be used to create one or more corresponding instances in other processes using the SharedRingBuffer::open method.

pub fn create_temp(
    size_in_bytes: u32
) -> Result<(String, SharedRingBuffer), Error>

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

The name of the file is returned along with the SharedRingBuffer and may be used to create one or more corresponding instances in other processes using the SharedRingBuffer::open method.

pub fn open(path: &str) -> Result<SharedRingBuffer, Error>

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

The file must already exist and have been initialized by a call to SharedRingBuffer::create or SharedRingBuffer::create_temp.

Trait Implementations

impl Sync for SharedRingBuffer

impl Clone for SharedRingBuffer

fn clone(&self) -> SharedRingBuffer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Send for SharedRingBuffer