Struct UsageWindowDescriptor 

pub struct UsageWindowDescriptor {
    pub key: String,
    pub scope: UsageWindowScope,
    pub meter: UsageWindowMeter,
    pub period_start_unix: Option<i64>,
    pub boundary_source: UsageWindowBoundarySource,
    pub boundary_confidence: UsageWindowBoundaryConfidence,
}

Stable semantics for one provider-specific quota window.

UsageWindow intentionally stays close to the upstream response. This descriptor supplies the extra identity and accounting semantics a host needs to match the same window across refreshes and completed periods.

Fields

key: String

Stable within one channel. Hosts that combine channels should namespace this key with Channel::id.

scope: UsageWindowScope

Which locally recorded traffic is governed by this window.

meter: UsageWindowMeter

The upstream unit represented by used, limit, or used_percent.

period_start_unix: Option<i64>

Inclusive period start, when it can be established, in unix seconds.

boundary_source: UsageWindowBoundarySource

How the period boundary was established.

boundary_confidence: UsageWindowBoundaryConfidence

Whether the complete boundary is exact, derived, partial, or unknown.

Implementations

impl UsageWindowDescriptor

pub fn from_window(window: &UsageWindow) -> Self

Conservative descriptor for a normalized window. Channel adapters can refine its scope and meter through Channel::describe_usage_window.

pub fn scope(self, scope: UsageWindowScope) -> Self

pub fn meter(self, meter: UsageWindowMeter) -> Self

pub fn period_start( self, unix: i64, source: UsageWindowBoundarySource, confidence: UsageWindowBoundaryConfidence, ) -> Self

Trait Implementations

impl Clone for UsageWindowDescriptor

fn clone(&self) -> UsageWindowDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UsageWindowDescriptor

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UsageWindowDescriptor

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for UsageWindowDescriptor

impl PartialEq for UsageWindowDescriptor

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for UsageWindowDescriptor

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for UsageWindowDescriptor