Skip to main content

UsageWindow

Struct UsageWindow 

Source
pub struct UsageWindow {
    pub name: String,
    pub label: Option<String>,
    pub used_percent: Option<f64>,
    pub used: Option<f64>,
    pub limit: Option<f64>,
    pub resets_at: Option<String>,
    pub resets_at_unix: Option<i64>,
    pub window_seconds: Option<i64>,
}
Expand description

A single rate-limit or quota window. Providers report usage either as a percentage (used_percent) or as absolute counts (used / limit); a window carries whichever the upstream gives. Reset time is kept verbatim as an ISO-8601 string (resets_at) and/or unix seconds (resets_at_unix).

Fields§

§name: String

Window id ("five_hour", "seven_day", "primary", a model id, …).

§label: Option<String>

Human-readable upstream label when name is generated.

§used_percent: Option<f64>§used: Option<f64>§limit: Option<f64>§resets_at: Option<String>

ISO-8601 reset timestamp, when the provider gives one.

§resets_at_unix: Option<i64>

Unix-seconds reset timestamp, when the provider gives one.

§window_seconds: Option<i64>

Window length in seconds, when known.

Implementations§

Source§

impl UsageWindow

Source

pub fn percent(name: impl Into<String>, used_percent: f64) -> Self

A percentage-based window (used_percent in [0, 100]).

Source

pub fn amounts(name: impl Into<String>, used: f64, limit: f64) -> Self

An absolute-count window (used / limit).

Source

pub fn resets_iso(self, iso: impl Into<String>) -> Self

Attach an ISO-8601 reset timestamp.

Source

pub fn resets_unix(self, unix: i64) -> Self

Attach a unix-seconds reset timestamp.

Source

pub fn window_secs(self, seconds: i64) -> Self

Attach the window length in seconds.

Source

pub fn label(self, label: impl Into<String>) -> Self

Attach a display label for generated / scoped windows.

Trait Implementations§

Source§

impl Clone for UsageWindow

Source§

fn clone(&self) -> UsageWindow

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 Debug for UsageWindow

Source§

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

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

impl Default for UsageWindow

Source§

fn default() -> UsageWindow

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

impl Serialize for UsageWindow

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

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> 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<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> 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 = 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