Struct itron_solid_fmp3::dataqueue::Dataqueue

pub struct Dataqueue(_);

This is supported on crate features unstable and dcre only.

An owned dataqueue.

Deletes the dataqueue automatically when dropped. The destructor will panic if the deletion fails.

Implementations

impl Dataqueue

pub fn build() -> Builder<__capacity_is_not_specified__>

acre_dtq: Create a builder for Dataqueue.

Examples

use itron::dataqueue::Dataqueue;
let dataqueue = Dataqueue::build()
    .capacity(2)
    .finish()
    .expect("failed to create a dataqueue");

dataqueue.as_ref().send(1)
   .expect("failed to send a data element");
dataqueue.as_ref().send(2)
   .expect("failed to send a data element");
dataqueue.as_ref().try_send(3)
   .expect_err("unexpectedly succeeded to send a data element");

impl Dataqueue

pub const unsafe fn from_raw_nonnull(id: NonNullID) -> Self

Construct a Dataqueue from a raw object ID.

Safety

See Object ID Wrappers.

pub const fn leak<'a>(self) -> DataqueueRef<'a>

Consume and “leak” self, returning a reference DataqueueRef<'a>.

pub const fn as_raw(&self) -> ID

Get the raw object ID.

pub const fn as_raw_nonnull(&self) -> NonNullID

Get the raw object ID as abi::NonNullID.

pub const fn as_ref(&self) -> DataqueueRef<'_>

Borrow Dataqueue as DataqueueRef.

Use this to perform operations on dataqueues because most of the methods are implemented on DataqueueRef but not Dataqueue.

Trait Implementations

impl Debug for Dataqueue

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

Formats the value using the given formatter.

impl Drop for Dataqueue

fn drop(&mut self)

Executes the destructor for this type.

impl PartialEq<Dataqueue> for Dataqueue

fn eq(&self, other: &Dataqueue) -> bool

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

fn ne(&self, other: &Dataqueue) -> bool

This method tests for !=.

impl Eq for Dataqueue

impl StructuralEq for Dataqueue

impl StructuralPartialEq for Dataqueue