Struct RateLimitValueUsage 

pub struct RateLimitValueUsage {
    pub operation_cents: u64,
    pub pending_cents: u64,
    pub type_: RateLimitValueUsageType,
    pub window_cents: u64,
}

USD totals, in cents, for a maxValueCents criterion. The criterion is met when windowCents + pendingCents + operationCents <= maxValueCents and unmet when the sum exceeds maxValueCents.

JSON schema

{
 "title": "RateLimitValueUsage",
 "description": "USD totals, in cents, for a `maxValueCents` criterion. The criterion is met when `windowCents + pendingCents + operationCents <= maxValueCents` and unmet when the sum exceeds `maxValueCents`.",
 "examples": [
   {
     "operationCents": 12550,
     "pendingCents": 0,
     "type": "value",
     "windowCents": 95000
   }
 ],
 "type": "object",
 "required": [
   "operationCents",
   "pendingCents",
   "type",
   "windowCents"
 ],
 "properties": {
   "operationCents": {
     "description": "The absolute USD value, in cents, of this operation.",
     "examples": [
       12550
     ],
     "type": "integer",
     "minimum": 0.0
   },
   "pendingCents": {
     "description": "USD value, in cents, added by earlier units of this simulation request. It is not persisted. Always `0` when `evaluatedUnit` is absent.",
     "examples": [
       0
     ],
     "type": "integer",
     "minimum": 0.0
   },
   "type": {
     "description": "The usage type.",
     "examples": [
       "value"
     ],
     "type": "string",
     "enum": [
       "value"
     ],
     "x-go-type": "string"
   },
   "windowCents": {
     "description": "USD value, in cents, counted in the current `window`.",
     "examples": [
       95000
     ],
     "type": "integer",
     "minimum": 0.0
   }
 },
 "additionalProperties": false
}

Fields

operation_cents: u64

The absolute USD value, in cents, of this operation.

pending_cents: u64

USD value, in cents, added by earlier units of this simulation request. It is not persisted. Always 0 when evaluatedUnit is absent.

type_: RateLimitValueUsageType

The usage type.

window_cents: u64

USD value, in cents, counted in the current window.

Implementations

impl RateLimitValueUsage

pub fn builder() -> RateLimitValueUsage

Trait Implementations

impl Clone for RateLimitValueUsage

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RateLimitValueUsage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RateLimitValueUsage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&RateLimitValueUsage> for RateLimitValueUsage

fn from(value: &RateLimitValueUsage) -> Self

Converts to this type from the input type.

impl From<RateLimitValueUsage> for RateLimitUsage

fn from(value: RateLimitValueUsage) -> Self

Converts to this type from the input type.

impl From<RateLimitValueUsage> for RateLimitValueUsage

fn from(value: RateLimitValueUsage) -> Self

Converts to this type from the input type.

impl Serialize for RateLimitValueUsage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<RateLimitValueUsage> for RateLimitValueUsage

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: RateLimitValueUsage) -> Result<Self, ConversionError>

Performs the conversion.