Struct RefusalDetail 

#[non_exhaustive]
pub struct RefusalDetail {
    pub class: ErrorClass,
    pub field: Option<String>,
    pub limit: Option<u64>,
    pub model: Option<String>,
    pub kind: Option<String>,
    pub estimate_usd: Option<Number>,
    pub max_cost_usd: Option<Number>,
    pub resets_at_ms: Option<u64>,
    pub retry_after_ms: Option<u64>,
    pub credential: Option<String>,
}

The detail of an admission refusal. Which members are present depends on the code (see the role contract’s table); class is always present, so a caller that meets an unknown code still knows whether to retry.

Fields (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.

class: ErrorClass

field: Option<String>

The offending or differing request field, as a path: a map key joined with a dot, an array index in brackets (items[2].state, questions.urgent.type). params names the request as a whole, and is used only when no narrower path applies. Each role contract lists its paths.

limit: Option<u64>

The limit the field exceeded, where one applies.

model: Option<String>

kind: Option<String>

The kind of a catalog row that is not the role’s kind, when the row states one.

estimate_usd: Option<Number>

max_cost_usd: Option<Number>

resets_at_ms: Option<u64>

retry_after_ms: Option<u64>

credential: Option<String>

On auth_failed, the id of the credential the runner presented (for example apikey:cloudflare), when the runner knows it, so an operator can tell which login to fix. Always an id, never the secret itself.

Implementations

impl RefusalDetail

pub fn new(class: ErrorClass) -> Self

pub fn with_field(self, field: impl Into<String>) -> Self

pub fn with_limit(self, limit: u64) -> Self

pub fn with_model(self, model: impl Into<String>) -> Self

pub fn with_kind(self, kind: impl Into<String>) -> Self

pub fn with_estimate_usd(self, estimate_usd: Number) -> Self

pub fn with_max_cost_usd(self, max_cost_usd: Number) -> Self

pub fn with_resets_at_ms(self, resets_at_ms: u64) -> Self

pub fn with_retry_after_ms(self, retry_after_ms: u64) -> Self

pub fn with_credential(self, credential: impl Into<String>) -> Self

Trait Implementations

impl Clone for RefusalDetail

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 RefusalDetail

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RefusalDetail

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RefusalDetail

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for RefusalDetail

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 RefusalDetail