Skip to main content

UsageSource

Enum UsageSource 

Source
pub enum UsageSource {
    Leased {
        lease_id: LeaseId,
        fencing_token: FencingToken,
    },
    Overage,
}
Expand description

What funded the units in a UsageEvent.

Two variants, because two things fund spend and they are validated by opposite rules. A leased charge arrives with a capability the sink checks before it touches the ledger; an overage charge has no capability to check, because no lease existed to issue one.

Making this a sum type rather than a pair of Options is deliberate. A half-formed capability — a lease id with no token, or a token naming no lease — is the shape a sink would have to defend against, and here it cannot be written down. The storage schema mirrors the same constraint.

Variants§

§

Leased

Spent from a lease. The sink requires the stored (lease_id, account_id, fencing_token) triple to match before the event may change either ledger; token age relative to another active lease is irrelevant (INVARIANTS.md GL-4).

Fields

§lease_id: LeaseId
§fencing_token: FencingToken
§

Overage

Admitted under EnforcementMode::Elastic with no lease behind it.

It carries no lease id on purpose, and must never be given one. Attributing unfunded spend to a real lease drives that lease’s used past its granted, which makes reclaim’s granted - used credit negative — a panic in the memory backend and a permanently failing transaction in Postgres, so the account’s expired leases would never be reclaimed again. Overage stands outside lease accounting entirely and is funded by its own ledger term.

Implementations§

Source§

impl UsageSource

Source

pub const fn lease_id(self) -> Option<LeaseId>

The lease this charge was spent from, or None for overage.

Source

pub const fn fencing_token(self) -> Option<FencingToken>

The referenced lease’s capability token, or None for overage.

Trait Implementations§

Source§

impl Clone for UsageSource

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 UsageSource

Source§

impl Debug for UsageSource

Source§

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

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

impl<'de> Deserialize<'de> for UsageSource

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 UsageSource

Source§

impl PartialEq for UsageSource

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 UsageSource

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 UsageSource

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.