Skip to main content

Singleflight

Struct Singleflight 

Source
pub struct Singleflight<T> { /* private fields */ }
Expand description

Coalesce concurrent loads for the same key.

Implementations§

Source§

impl<T> Singleflight<T>

Source

pub fn new(fail_ttl: Duration) -> Self

Source

pub fn get_ready(&self, key: &LoadKey) -> Option<Arc<T>>

Source

pub fn contains_ready(&self, key: &LoadKey) -> bool

Source

pub fn invalidate(&self, key: &LoadKey)

Source

pub fn clear(&self)

Source

pub fn ready_count(&self) -> usize

Source

pub fn finish_load_published(&self, key: &LoadKey)

Complete a coalesced load without retaining a permanent Ready slot (JOE-1646). The caller must have already published the value into the authoritative registry. Waiters wake, see no Loading slot, and re-query the registry.

Source

pub fn finish_load_failed(&self, key: &LoadKey, message: String)

Mark a failed coalesced load.

Source

pub fn begin_or_wait(&self, key: &LoadKey) -> BeginLoad

Begin a coalesced load for registry-owned residency (JOE-1646).

Source

pub fn begin_or_wait_guard( &self, key: LoadKey, ) -> Result<Option<LeaderGuard<'_, T>>, String>

Acquire leadership for key and return a panic-safe LeaderGuard.

Ok(None) means another load finished — re-check the registry. Err is a cached failure message still within TTL.

Source§

impl<T: Send + Sync + 'static> Singleflight<T>

Source

pub fn get_or_load<F>(&self, key: LoadKey, loader: F) -> Result<Arc<T>>
where F: FnOnce() -> Result<T>,

Load key using loader exactly once for concurrent callers.

The registry mutex is not held during loader. Leader panics are converted to a failed slot so waiters never hang.

Trait Implementations§

Source§

impl<T> Default for Singleflight<T>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<T> !Freeze for Singleflight<T>

§

impl<T> RefUnwindSafe for Singleflight<T>

§

impl<T> Send for Singleflight<T>
where T: Sync + Send,

§

impl<T> Sync for Singleflight<T>
where T: Sync + Send,

§

impl<T> Unpin for Singleflight<T>

§

impl<T> UnsafeUnpin for Singleflight<T>

§

impl<T> UnwindSafe for Singleflight<T>

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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