Skip to main content

ProbeHoldOutcome

Enum ProbeHoldOutcome 

Source
pub enum ProbeHoldOutcome {
    Held,
    Unavailable,
    BudgetExhausted,
    HoldsDisabled,
}
Expand description

Outcome of crate::CacheEngine::try_probe_hold, carrying two independent facts (ADR 005 §Probe-triggered eviction hold):

Holds are best-effort, so these are two independent bits: Self::BudgetExhausted advertises without holding. Use the two predicates rather than matching on variants, so the mapping stays in one place; the variants themselves exist so the probe handler can emit the right metric without a second cache lookup.

Variants§

§

Held

Blob present (and not operator-evicted) and an eviction hold was placed, so the blob stays resident for the follow-up pull — sign has_blob: true.

§

Unavailable

Blob absent or operator-evicted — sign has_blob: false. Not a degradation: the node simply does not have the content.

Deliberately the one outcome with no metric. The probe_hold_unavailable counter records hold refusals for content the node has; a true negative is not a refusal, and counting it would swamp the signal every alert on that metric depends on. Despite the shared word, this is not ProbeHoldUnavailableReason — that enum’s values all mean “we have it but would not hold it”.

§

BudgetExhausted

Blob present but all hold slots are in use (max_probe_holds > 0 and the live-hold count has reached it). The caller still advertises has_blob: true but places no hold, so the blob may be LRU-evicted before the pull — costing one wasted round trip, never a slash. Counted as probe_hold_unavailable{reason="exhausted"} (ADR 005 §Hold budget); the operator-actionable remedy for the lost holds is to raise max_probe_holds.

§

HoldsDisabled

Blob present but the eviction-hold path is disabled by config (max_probe_holds == 0) — the operator opt-out from advertising store-backed content, so the caller signs has_blob: false. Operationally distinct from Self::BudgetExhausted (#739): a deliberate choice, not load. Counted as probe_hold_unavailable{reason="disabled"}, never as {reason="exhausted"} (whose alert remedy is “increase max_probe_holds”, nonsensical when holds are deliberately off).

Scope note: this silences store-backed advertisements only. Content servable from a configured origin takes no hold and is advertised regardless — see the origin-held fallback in the probe handler.

Implementations§

Source§

impl ProbeHoldOutcome

Source

pub const fn advertises(self) -> bool

Whether this outcome authorises signing has_blob: true for the store-backed answer (the origin-held fallback may still promote a false afterwards).

Presence governs the answer, not the hold: Self::BudgetExhausted advertises despite placing no hold, because refusing there would let a probe flood that fills the hold cache suppress truthful answers.

Source

pub const fn hold_placed(self) -> bool

Whether an eviction hold was actually placed, making the blob LRU-exempt for PROBE_HOLD_DURATION.

Distinct from Self::advertises: holds are best-effort, and only Self::Held consumes a slot.

Trait Implementations§

Source§

impl Clone for ProbeHoldOutcome

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for ProbeHoldOutcome

Source§

impl Debug for ProbeHoldOutcome

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for ProbeHoldOutcome

Source§

impl PartialEq for ProbeHoldOutcome

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ProbeHoldOutcome

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> AsOut<T> for T
where T: Copy,

Source§

fn as_out(&mut self) -> Out<'_, T>

Returns an out reference to self.
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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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