Struct spsc_bip_buffer::BipBufferWriterReservation

pub struct BipBufferWriterReservation<'a> { /* fields omitted */ }

A write reservation returned by reserve or spin_reserve. The sender can access the reserved buffer slice by dererferencing this reservation. Its size is guaranteed to match the requested length in reserve or spin_reserve.

There are no guarantees on the contents of the buffer slice when a new reservation is created: the slice may contain stale data or garbage.

Dropping the reservation (or calling send, which consumes self) marks the end of the write and informs the reader that the data in this slice can now be read.

Don't drop the reservation before you're done writing!

Examples

use spsc_bip_buffer::bip_buffer_from;
let (mut writer, _) = bip_buffer_from(vec![0u8; 1024]);
std::thread::spawn(move || {
  let mut reservation = writer.spin_reserve(4);
  reservation[0] = 0xf0;
  reservation[1] = 0x0f;
  reservation[2] = 0x00;
  reservation[3] = 0xee;
  reservation.send();
}).join().unwrap();

use spsc_bip_buffer::bip_buffer_from;
let (mut writer, _) = bip_buffer_from(vec![0u8; 1024]);
std::thread::spawn(move || {
  let mut reservation = writer.spin_reserve(4);
  let data = vec![0xf0, 0x0f, 0x00, 0xee];
  reservation.copy_from_slice(&data[..]);
  // drop reservation, which sends data
}).join().unwrap();

Methods

impl<'a> BipBufferWriterReservation<'a>

pub fn send(self)

Calling send (or simply dropping the reservation) marks the end of the write and informs the reader that the data in this slice can now be read.

Trait Implementations

impl<'a> Drop for BipBufferWriterReservation<'a>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a> Deref for BipBufferWriterReservation<'a>

type Target = [u8]

The resulting type after dereferencing.

fn deref(&self) -> &[u8]

Dereferences the value.

impl<'a> DerefMut for BipBufferWriterReservation<'a>

fn deref_mut(&mut self) -> &mut [u8]

Mutably dereferences the value.