pub struct UsageRecorder { /* private fields */ }Expand description
Combines in-memory UsageStats with an optional persistent UsageStore.
Every record_* call updates the in-memory counters immediately and, if a
store is configured, sends the record to a single background task that
batches writes to reduce spawn overhead and SQLite write contention.
Implementations§
Source§impl UsageRecorder
impl UsageRecorder
Sourcepub fn new(store: Option<Arc<dyn UsageStore>>) -> Self
pub fn new(store: Option<Arc<dyn UsageStore>>) -> Self
Creates a new recorder, optionally backed by a persistent store.
When a store is provided a background flush loop is spawned that drains records from an mpsc channel in micro-batches (up to 64 at a time).
Sourcepub fn record_success(
&self,
model: &str,
provider: &str,
input_tokens: u64,
output_tokens: u64,
)
pub fn record_success( &self, model: &str, provider: &str, input_tokens: u64, output_tokens: u64, )
Record a successful request with token counts.
Uses DEFAULT_ACCOUNT as the account attribution; call
record_success_for when the specific
OAuth account is known.
Sourcepub fn record_success_for(
&self,
model: &str,
provider: &str,
account_id: &str,
input_tokens: u64,
output_tokens: u64,
)
pub fn record_success_for( &self, model: &str, provider: &str, account_id: &str, input_tokens: u64, output_tokens: u64, )
Record a successful request with token counts, attributing it to a specific account.
Sourcepub fn record_failure(&self, model: &str, provider: &str)
pub fn record_failure(&self, model: &str, provider: &str)
Record a failed request.
Sourcepub fn record_failure_for(&self, model: &str, provider: &str, account_id: &str)
pub fn record_failure_for(&self, model: &str, provider: &str, account_id: &str)
Record a failed request, attributing it to a specific account.
Sourcepub fn snapshot(&self) -> UsageSnapshot
pub fn snapshot(&self) -> UsageSnapshot
Take a snapshot of in-memory stats.
Sourcepub fn preload(
&self,
model: &str,
requests: u64,
input_tokens: u64,
output_tokens: u64,
)
pub fn preload( &self, model: &str, requests: u64, input_tokens: u64, output_tokens: u64, )
Pre-load cumulative counters from historical totals (e.g. on startup).
Sourcepub fn store(&self) -> Option<&Arc<dyn UsageStore>>
pub fn store(&self) -> Option<&Arc<dyn UsageStore>>
Returns a reference to the backing store (if configured).
Auto Trait Implementations§
impl !Freeze for UsageRecorder
impl !RefUnwindSafe for UsageRecorder
impl Send for UsageRecorder
impl Sync for UsageRecorder
impl Unpin for UsageRecorder
impl UnsafeUnpin for UsageRecorder
impl !UnwindSafe for UsageRecorder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);