Skip to main content

Outcome

ai_usagebar::outcome

Struct Outcome

pub struct Outcome<T> {
    pub snapshot: T,
    pub stale: bool,
    pub last_error: Option<(u16, String)>,
    pub cache_age: Option<Duration>,
}

Expand description

A snapshot with its provenance.

Fields§

§snapshot: T§stale: bool

The payload is past its TTL — shown, but marked.

§last_error: Option<(u16, String)>

The failure recorded by the most recent unsuccessful refresh, redacted by Cache::write_last_error. None means the last refresh worked.

§cache_age: Option<Duration>

How long ago the payload was written. None when unknown.

Implementations§

impl<T> Outcome<T>

pub fn fresh(snapshot: T) -> Self

Straight off the wire: fresh, no recorded error, zero age.

Note the deliberate asymmetry with Outcome::cached — a successful fetch clears last_error rather than reading it back, because the error it would read is the one this call just superseded.

pub fn cached(snapshot: T, cache: &Cache, stale: bool) -> Self

Parsed back out of the cache. The recorded error and the payload’s age come from the cache, so a warm-cache render still shows why the last refresh failed.

pub fn map<U>(self, f: impl FnOnce(T) -> U) -> Outcome<U>

Re-type the snapshot, keeping the provenance. This is how a vendor’s own outcome becomes a crate::vendor::VendorOutcome.

Trait Implementations§

impl<T: Clone> Clone for Outcome<T>

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

impl<T: Debug> Debug for Outcome<T>

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

Formats the value using the given formatter. Read more

impl From<Outcome<AnthropicApiSnapshot>> for VendorOutcome

fn from(o: FetchOutcome) -> Self

Converts to this type from the input type.

impl From<Outcome<AntigravitySnapshot>> for VendorOutcome

fn from(o: FetchOutcome) -> Self

Converts to this type from the input type.

impl From<Outcome<CursorSnapshot>> for VendorOutcome

fn from(o: FetchOutcome) -> Self

Converts to this type from the input type.

impl From<Outcome<CustomSnapshot>> for VendorOutcome

fn from(o: FetchOutcome) -> Self

Converts to this type from the input type.

impl From<Outcome<DeepseekSnapshot>> for VendorOutcome

fn from(o: FetchOutcome) -> Self

Converts to this type from the input type.

impl From<Outcome<GrokSnapshot>> for VendorOutcome

fn from(o: FetchOutcome) -> Self

Converts to this type from the input type.

impl From<Outcome<GrokbotSnapshot>> for VendorOutcome

fn from(o: FetchOutcome) -> Self

Converts to this type from the input type.

impl From<Outcome<KiloSnapshot>> for VendorOutcome

fn from(o: FetchOutcome) -> Self

Converts to this type from the input type.

impl From<Outcome<KimiSnapshot>> for VendorOutcome

fn from(o: FetchOutcome) -> Self

Converts to this type from the input type.

impl From<Outcome<KiroSnapshot>> for VendorOutcome

fn from(o: FetchOutcome) -> Self

Converts to this type from the input type.

impl From<Outcome<MinimaxSnapshot>> for VendorOutcome

fn from(o: FetchOutcome) -> Self

Converts to this type from the input type.

impl From<Outcome<ModelStudioSnapshot>> for VendorOutcome

fn from(o: FetchOutcome) -> Self

Converts to this type from the input type.

impl From<Outcome<MoonshotSnapshot>> for VendorOutcome

fn from(o: FetchOutcome) -> Self

Converts to this type from the input type.

impl From<Outcome<NovitaSnapshot>> for VendorOutcome

fn from(o: FetchOutcome) -> Self

Converts to this type from the input type.

impl From<Outcome<OllamaSnapshot>> for VendorOutcome

fn from(o: FetchOutcome) -> Self

Converts to this type from the input type.

impl From<Outcome<OpenAiSnapshot>> for VendorOutcome

fn from(o: FetchOutcome) -> Self

Converts to this type from the input type.

impl From<Outcome<OpenRouterSnapshot>> for VendorOutcome

fn from(o: FetchOutcome) -> Self

Converts to this type from the input type.

impl From<Outcome<OrcaRouterSnapshot>> for VendorOutcome

fn from(o: FetchOutcome) -> Self

Converts to this type from the input type.

impl From<Outcome<Snapshot>> for VendorOutcome

fn from(outcome: FetchOutcome) -> Self

Converts to this type from the input type.

impl From<Outcome<Snapshot>> for VendorOutcome

fn from(outcome: FetchOutcome) -> Self

Converts to this type from the input type.

impl From<Outcome<SuperGrokSnapshot>> for VendorOutcome

fn from(o: FetchOutcome) -> Self

Converts to this type from the input type.

impl From<Outcome<Usage>> for VendorOutcome

fn from(outcome: FetchOutcome) -> Self

Converts to this type from the input type.

impl From<Outcome<ZaiSnapshot>> for VendorOutcome

fn from(o: FetchOutcome) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

impl<T> Freeze for Outcome<T>
where T: Freeze,

impl<T> RefUnwindSafe for Outcome<T>
where T: RefUnwindSafe,

impl<T> Send for Outcome<T>
where T: Send,

impl<T> Sync for Outcome<T>
where T: Sync,

impl<T> Unpin for Outcome<T>
where T: Unpin,

impl<T> UnsafeUnpin for Outcome<T>
where T: UnsafeUnpin,

impl<T> UnwindSafe for Outcome<T>
where T: UnwindSafe,

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self> ⓘ

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

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoEither for T

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

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

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

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

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

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = !

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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