Skip to main content

CapacityClass

Enum CapacityClass 

Source
pub enum CapacityClass {
    Assured,
    BestEffort,
}
Expand description

Which execution-capacity class an account’s work belongs to (GL-99).

A separate axis from EnforcementMode, and the two must not be conflated. Enforcement mode answers whether an account can fund a request; this answers whether an instance should start an already-valid request with the compute capacity it has right now. An assured account may be strict, and a best-effort account still spends quota and emits ordinary usage whenever it does execute.

The vocabulary is deliberately semantic rather than commercial. Tollgate has no Paid/Free and no open-ended priority integer: the product maps its plans onto these two, and which customers are assured is a decision that stays outside an enforcement substrate.

§Assured is the default, and that is a compatibility choice

An account that states no class gets the availability every account has today. The unsafe direction would be defaulting to BestEffort, which would silently make existing traffic sheddable the moment a capacity gate was enabled — the same reasoning that makes AccountStatus required at construction and EnforcementMode default to Strict.

Variants§

§

Assured

Work that may use the whole instance, including the reserve kept for it. The default.

§

BestEffort

Work that may use only capacity not reserved for assured traffic, and is shed first under load.

Implementations§

Source§

impl CapacityClass

Source

pub const fn as_str(self) -> &'static str

The one spelling of each class: serde’s, the ledger column’s, and the operator-facing one.

The same three-consumer argument AccountStatus::as_str makes — the tollgate_accounts.capacity_class CHECK constraint, the JSONB predicate deciding which snapshots a class change rewrites, and the admin wire DTO all compare these strings, so they all read from here. It is also the metric label: capacity counters distinguish the classes by these two tags and nothing else, which is what keeps their cardinality bounded (GL-99).

Source

pub const fn may_use_assured_reserve(self) -> bool

Whether work of this class may draw on the assured reserve.

Stated once, here, rather than re-derived as == Assured at each pool decision: the reserve’s whole purpose is that exactly one class reaches it, and a second spelling of that rule is how the two drift.

Trait Implementations§

Source§

impl Clone for CapacityClass

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 CapacityClass

Source§

impl Debug for CapacityClass

Source§

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

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

impl Default for CapacityClass

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for CapacityClass

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 CapacityClass

Source§

impl PartialEq for CapacityClass

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 CapacityClass

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 CapacityClass

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.