Struct itron_solid_fmp3::dataqueue::DataqueueRef

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

This is supported on crate feature unstable only.

A borrowed reference to a dataqueue.

Implementations

impl DataqueueRef<'_>

Object ID conversion

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

Construct a DataqueueRef from a raw object ID.

Safety

See Object ID Wrappers.

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.

impl DataqueueRef<'_>

Management

pub unsafe fn delete(self) -> Result<(), Error<DeleteError>>

This is supported on crate feature dcre only.

del_dtq: Delete the dataqueue.

Safety

See Object ID Wrappers.

pub fn info(self) -> Result<Info, Error<InfoError>>

ref_dtq: Get the dataqueue’s general information.

impl DataqueueRef<'_>

Dataqueue Operations

pub fn send(self, data_element: DataElement) -> Result<(), Error<SendError>>

snd_dtq: Send a data element to the dataqueue. Blocks the current task if the dataqueue is full.

pub fn send_timeout(
    self,
    data_element: DataElement,
    tmo: Timeout
) -> Result<(), Error<SendTimeoutError>>

tsnd_dtq: Send a data element to the dataqueue. Blocks the current task with timeout if the dataqueue is full.

pub fn try_send(
    self,
    data_element: DataElement
) -> Result<(), Error<TrySendError>>

psnd_dtq: Send a data element to the dataqueue. Fails and returns an error if the dataqueue is full.

pub fn send_forced(
    self,
    data_element: DataElement
) -> Result<(), Error<SendForcedError>>

fsnd_dtq: Send a data element to the dataqueue. Removes (“pushes out”) the oldest element if the dataqueue is full.

pub fn recv(self) -> Result<DataElement, Error<RecvError>>

rcv_dtq: Receive a data element from the dataqueue. Blocks the current task if the dataqueue is empty.

Rationale

This method is named recv instead of receive following the suit of std::sync::mpsc::Receiver::recv and std::net::UdpSocket::recv.

pub fn recv_timeout(
    self,
    tmo: Timeout
) -> Result<DataElement, Error<RecvTimeoutError>>

trcv_dtq: Receive a data element to the dataqueue. Blocks the current task with timeout if the dataqueue is empty.

pub fn try_recv(self) -> Result<DataElement, Error<TryRecvError>>

prcv_dtq: Receive a data element to the dataqueue. Fails and returns an error if the dataqueue is empty.

pub fn initialize(self) -> Result<(), Error<InitializeError>>

ini_sem: Initialize the dataqueue.

Trait Implementations

impl<'a> Clone for DataqueueRef<'a>

fn clone(&self) -> DataqueueRef<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DataqueueRef<'_>

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

Formats the value using the given formatter.

impl<'a> PartialEq<DataqueueRef<'a>> for DataqueueRef<'a>

fn eq(&self, other: &DataqueueRef<'a>) -> bool

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

fn ne(&self, other: &DataqueueRef<'a>) -> bool

This method tests for !=.

impl<'a> Copy for DataqueueRef<'a>

impl<'a> Eq for DataqueueRef<'a>

impl<'a> StructuralEq for DataqueueRef<'a>

impl<'a> StructuralPartialEq for DataqueueRef<'a>