Struct AcquireError 

#[non_exhaustive]
pub struct AcquireError<P> {
    pub params: P,
}

The error returned by Acquire if the semaphore queue was closed.

struct Counter(usize);

impl flag_bearer::SemaphoreState for Counter {
    type Params = ();
    type Permit = ();

    fn acquire(&mut self, _: Self::Params) -> Result<Self::Permit, Self::Params> {
        if self.0 > 0 {
            self.0 -= 1;
            Ok(())
        } else {
            Err(())
        }
    }

    fn release(&mut self, _: Self::Permit) {
        self.0 += 1;
    }
}

let s = flag_bearer::new_fifo().closeable().with_state(Counter(1));

// closing the semaphore makes all current and new acquire() calls return an error.
s.close();

let _err = s.acquire(()).await.unwrap_err();

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

params: P

The params that was used in the acquire request

Implementations

impl AcquireError<Uncloseable>

pub fn never(self) -> !

Since the SemaphoreQueue is Uncloseable, there can never be an acquire error. This allows for unwrapping with type-safety.

Trait Implementations

impl<P> Debug for AcquireError<P>

where P: Debug,

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

Formats the value using the given formatter.

impl<P> Display for AcquireError<P>

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

Formats the value using the given formatter.

impl<P> PartialEq for AcquireError<P>

where P: PartialEq,

fn eq(&self, other: &AcquireError<P>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<P> Eq for AcquireError<P>

where P: Eq,

impl<P> StructuralPartialEq for AcquireError<P>