OwnedSemaphore

Struct OwnedSemaphore 

Source
pub struct OwnedSemaphore { /* private fields */ }
Expand description

An owned semaphore is identical to a Semaphore except it can be owned by an actor and it’s permits can still be shared externally.

Implementations§

Source§

impl OwnedSemaphore

Source

pub fn new(permits: usize) -> Self

Creates a new instance of OwnedSemaphore with the given permits count that can be used with owned permits.

This can be used to create a owned semaphore that lives in a state:

use hydra::OwnedSemaphore;

struct MyServer {
    rate_limit: OwnedSemaphore,
}

impl MyServer {
    pub fn new() -> Self {
        Self {
            rate_limit: OwnedSemaphore::new(100),
        }
    }
}
Source

pub async fn acquire(&self) -> SemaphorePermit<'_>

Acquires one permit asynchronously waiting for one to become available.

Source

pub async fn acquire_owned(&self) -> OwnedSemaphorePermit

Acquires one permit asynchronously waiting for one to become available.

Source

pub async fn acquire_many(&self, count: u32) -> SemaphorePermit<'_>

Acquires many permits asynchronously waiting for them to become available.

Source

pub async fn acquire_many_owned(&self, count: u32) -> OwnedSemaphorePermit

Acquires many permits asynchronously waiting for them to become available.

Source

pub fn try_acquire(&self) -> Result<SemaphorePermit<'_>, NoPermits>

Attempts to acquire a permit, returning an error if there are none available.

Source

pub fn try_acquire_owned(&self) -> Result<OwnedSemaphorePermit, NoPermits>

Attempts to acquire a permit, returning an error if there are none available.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more