Struct itron_solid_fmp3::semaphore::SemaphoreRef

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

This is supported on crate feature unstable only.

A borrowed reference to a semaphore.

Implementations

impl SemaphoreRef<'_>

Object ID conversion

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

Construct a SemaphoreRef 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 SemaphoreRef<'_>

Management

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

This is supported on crate feature dcre only.

del_sem: Delete the semaphore.

Safety

See Object ID Wrappers.

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

ref_sem: Get the semaphore’s general information.

impl SemaphoreRef<'_>

Semaphore Operations

pub fn signal(self) -> Result<(), Error<SignalError>>

sig_sem: Increment the semaphore count by one.

pub fn wait(self) -> Result<(), Error<WaitError>>

wai_sem: Decrement the semaphore count by one. Blocks the current task if the new value is negative.

pub fn wait_timeout(self, tmo: Timeout) -> Result<(), Error<WaitTimeoutError>>

twai_sem: Decrement the semaphore count by one. Blocks the current task with timeout if the new value is negative.

pub fn poll(self) -> Result<(), Error<PollError>>

pol_sem: Decrement the semaphore count by one. Fails and returns immediately if the new value is negative.

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

ini_sem: Initialize the semaphore.

Trait Implementations

impl<'a> Clone for SemaphoreRef<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SemaphoreRef<'_>

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

Formats the value using the given formatter.

impl<'a> PartialEq<SemaphoreRef<'a>> for SemaphoreRef<'a>

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

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

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

This method tests for !=.

impl<'a> Copy for SemaphoreRef<'a>

impl<'a> Eq for SemaphoreRef<'a>

impl<'a> StructuralEq for SemaphoreRef<'a>

impl<'a> StructuralPartialEq for SemaphoreRef<'a>