Struct ipmpsc::SharedRingBuffer [−][src]
pub struct SharedRingBuffer(_);
Expand description
Represents a file-backed shared memory ring buffer, suitable for constructing a
Receiver
or Sender
.
Note that it is possible to create multiple SharedRingBuffer
s 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.
Implementations
impl SharedRingBuffer
[src]
impl SharedRingBuffer
[src]pub fn create(path: &str, size_in_bytes: u32) -> Result<Self>
[src]
pub fn create(path: &str, size_in_bytes: u32) -> Result<Self>
[src]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, Self)>
[src]
pub fn create_temp(size_in_bytes: u32) -> Result<(String, Self)>
[src]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<Self>
[src]
pub fn open(path: &str) -> Result<Self>
[src]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 Clone for SharedRingBuffer
[src]
impl Clone for SharedRingBuffer
[src]fn clone(&self) -> SharedRingBuffer
[src]
fn clone(&self) -> SharedRingBuffer
[src]Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]Performs copy-assignment from source
. Read more
impl Send for SharedRingBuffer
[src]
impl Sync for SharedRingBuffer
[src]
Auto Trait Implementations
impl !RefUnwindSafe for SharedRingBuffer
impl Unpin for SharedRingBuffer
impl !UnwindSafe for SharedRingBuffer
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,