Struct bbqueue_ng::GrantW

pub struct GrantW<'a, const N: usize> { /* fields omitted */ }

A structure representing a contiguous region of memory that may be written to, and potentially "committed" to the queue.

NOTE: If the grant is dropped without explicitly commiting the contents, or by setting a the number of bytes to automatically be committed with to_commit(), then no bytes will be comitted for writing.

If the thumbv6 feature is selected, dropping the grant without committing it takes a short critical section,

Implementations

impl<'a, const N: usize> GrantW<'a, { N }>

pub fn commit(self, used: usize)

Finalizes a writable grant given by grant() or grant_max(). This makes the data available to be read via read(). This consumes the grant.

If used is larger than the given grant, the maximum amount will be commited

NOTE: If the thumbv6 feature is selected, this function takes a short critical section while committing.

pub fn buf(&mut self) -> &mut [u8]

Obtain access to the inner buffer for writing

use bbqueue_ng::BBBuffer;

// Create and split a new buffer of 6 elements
let buffer: BBBuffer<6> = BBBuffer::new();
let (mut prod, mut cons) = buffer.try_split().unwrap();

// Successfully obtain and commit a grant of four bytes
let mut grant = prod.grant_max_remaining(4).unwrap();
grant.buf().copy_from_slice(&[1, 2, 3, 4]);
grant.commit(4);

pub unsafe fn as_static_mut_buf(&mut self) -> &'static mut [u8]

Sometimes, it's not possible for the lifetimes to check out. For example, if you need to hand this buffer to a function that expects to receive a &'static mut [u8], it is not possible for the inner reference to outlive the grant itself.

You MUST guarantee that in no cases, the reference that is returned here outlives the grant itself. Once the grant has been released, referencing the data contained WILL cause undefined behavior.

Additionally, you must ensure that a separate reference to this data is not created to this data, e.g. using DerefMut or the buf() method of this grant.

pub fn to_commit(&mut self, amt: usize)

Configures the amount of bytes to be commited on drop.

Trait Implementations

impl<'a, const N: usize> Debug for GrantW<'a, N>

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a, const N: usize> Deref for GrantW<'a, N>

type Target = [u8]

The resulting type after dereferencing.

pub fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a, const N: usize> DerefMut for GrantW<'a, N>

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

Mutably dereferences the value.

impl<'a, const N: usize> Drop for GrantW<'a, N>

pub fn drop(&mut self)

Executes the destructor for this type.

impl<'a, const N: usize> PartialEq<GrantW<'a, N>> for GrantW<'a, N>

pub fn eq(&self, other: &GrantW<'a, N>) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &GrantW<'a, N>) -> bool

This method tests for !=.

impl<'a, const N: usize> Send for GrantW<'a, { N }>

impl<'a, const N: usize> StructuralPartialEq for GrantW<'a, N>