Skip to main content

UsageEvent

Struct UsageEvent 

Source
#[non_exhaustive]
pub struct UsageEvent { pub request_id: RequestId, pub account_id: AccountId, pub source: UsageSource, pub units: CostUnits, pub occurred_at: Timestamp, pub policy_revision: PolicyRevision, pub key_id: Option<KeyId>, }
Expand description

One committed charge. Produced only from a committed crate::reservation::Reservation; there is deliberately no public constructor path for uncommitted work.

#[non_exhaustive] is what makes that sentence true outside this crate rather than merely stated. The type had said “produced only from a committed reservation” while remaining a plain struct literal any crate could fill in, which is a convention rather than a boundary; a caller could assemble an event for work that never committed and hand it to a sink. Construction now goes through UsageEvent::new, and the sealing has a second benefit the workspace pays for once: a field added here no longer breaks every literal in every downstream test.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§request_id: RequestId

Idempotency key: a sink must treat a replayed request_id as the same charge, not a new one.

The only field of this struct that is independent of how the units were funded, which is what lets overage replay under the same rule as any other event (INVARIANTS.md GL-7).

§account_id: AccountId§source: UsageSource

What funded the units, and the evidence the sink validates.

§units: CostUnits§occurred_at: Timestamp§policy_revision: PolicyRevision

The consuming application’s policy identity, copied from the pinned snapshot that priced this request (GL-94).

Carried so a billing record can be traced to the exact product policy that produced it. Tollgate never reads it, and an event from a publisher that stated no revision carries PolicyRevision::UNSTATED.

Defaults on the wire, so an ingest from a peer that predates the field decodes rather than failing — the same rule the snapshot’s optional fields follow.

§key_id: Option<KeyId>

Credential named by the pinned, key-scoped snapshot. An absent value preserves billing but supplies no credential activity. This metadata is never authorization evidence; the sink checks account ownership.

Implementations§

Source§

impl UsageEvent

Source

pub const fn new( request_id: RequestId, account_id: AccountId, source: UsageSource, units: CostUnits, occurred_at: Timestamp, policy_revision: PolicyRevision, key_id: Option<KeyId>, ) -> Self

Build a committed charge.

Called by Reservation::usage_event, which is the only place that can prove the charge committed. It is public because tests, benchmarks, and store backends across the workspace need to construct events without a live reservation; what #[non_exhaustive] buys is that every such construction goes through one signature, so a new field reaches them as a compile error at one call each rather than as a silent default.

Trait Implementations§

Source§

impl Clone for UsageEvent

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 UsageEvent

Source§

impl Debug for UsageEvent

Source§

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

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

impl<'de> Deserialize<'de> for UsageEvent

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for UsageEvent

Source§

impl PartialEq for UsageEvent

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 Serialize for UsageEvent

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
Source§

impl StructuralPartialEq for UsageEvent

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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

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.