Struct BBQueue 

pub struct BBQueue<S, C, N> { /* private fields */ }

A standard bbqueue

Implementations

impl<S: Storage, C: Coord, N: Notifier> BBQueue<S, C, N>

pub fn new_with_storage(sto: S) -> Self

Create a new BBQueue with the given Storage impl

impl<S: ConstStorage, C: Coord, N: Notifier> BBQueue<S, C, N>

pub const fn new() -> Self

Create a new BBQueue in a const context

impl<S: Storage, C: Coord, N: Notifier> BBQueue<S, C, N>

pub const fn framed_producer(&self) -> FramedProducer<&Self>

Create a new FramedProducer for this BBQueue

Although mixing stream and framed consumer/producers will not result in UB, it will also not work correctly.

pub const fn framed_consumer(&self) -> FramedConsumer<&Self>

Create a new FramedConsumer for this BBQueue

Although mixing stream and framed consumer/producers will not result in UB, it will also not work correctly.

pub const fn stream_producer(&self) -> StreamProducer<&Self>

Create a new StreamProducer for this BBQueue

Although mixing stream and framed consumer/producers will not result in UB, it will also not work correctly.

pub const fn stream_consumer(&self) -> StreamConsumer<&Self>

Create a new StreamConsumer for this BBQueue

Although mixing stream and framed consumer/producers will not result in UB, it will also not work correctly.

pub fn capacity(&self) -> usize

Get the total capacity of the buffer, e.g. how much space is present in Storage

pub fn storage(&self) -> &S

Get access to the internal storage implementation details

NOTE: Although this method is safe, use of the Storage methods are not. You should never attempt to access or modify the underlying data contained in a storage implementation while the bbqueue is live. That will IMMEDIATELY lead to undefined behavior.

As far as I am aware, the only reasonable use for this is for cases where you have a custom Storage implementation that has unique teardown/drop in place requirements. Treat any uses of this function with extreme caution!

Trait Implementations

impl<S: Storage, C: Coord, N: Notifier> BbqHandle for &BBQueue<S, C, N>

type Target = &BBQueue<S, C, N>

How we reference our BBQueue.

type Storage = S

How the DATA of our BBQueue is stored

type Coord = C

How the producers/consumers of this BBQueue coordinate

type Notifier = N

How we notify the producer/consumers of this BBQueue

fn bbq_ref(&self) -> Self::Target

Obtain a reference to the pointed-to BBQueue

fn stream_producer(&self) -> StreamProducer<Self>

Create a StreamProducer from our Target’s BBQueue.

fn stream_consumer(&self) -> StreamConsumer<Self>

Create a StreamConsumer from our Target’s BBQueue.

fn framed_producer<H: LenHeader>(&self) -> FramedProducer<Self, H>

Create a FramedProducer from our Target’s BBQueue.

fn framed_consumer<H: LenHeader>(&self) -> FramedConsumer<Self, H>

Create a FramedConsumer from our Target’s BBQueue.