Struct leaky_bucket::Acquire

pub struct Acquire<'a>(_);

The future associated with acquiring permits from a rate limiter using RateLimiter::acquire.

Implementations

impl Acquire<'_>

pub fn is_core(&self) -> bool

Test if this acquire task is currently coordinating the rate limiter.

Examples

use leaky_bucket::RateLimiter;
use std::future::Future;
use std::sync::Arc;
use std::task::Context;

struct Waker;

let limiter = RateLimiter::builder().build();

let waker = Arc::new(Waker).into();
let mut cx = Context::from_waker(&waker);

let a1 = limiter.acquire(1);
tokio::pin!(a1);

assert!(!a1.is_core());
assert!(a1.as_mut().poll(&mut cx).is_pending());
assert!(a1.is_core());

a1.as_mut().await;

// After completion this is no longer a core.
assert!(!a1.is_core());

Trait Implementations

impl Future for Acquire<'_>

type Output = ()

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.