Struct Refusal 

#[non_exhaustive]
pub struct Refusal {
    pub code: String,
    pub message: String,
    pub detail: Box<RefusalDetail>,
}

An admission refusal: the body of the ERROR frame a batch call answers with, {code, message, detail}, the shape of subc_protocol::ErrorBody with a typed detail.

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.

code: String

An admission code this crate lists; any other value decodes as a plain string.

message: String

detail: Box<RefusalDetail>

Boxed so a Result<_, Refusal> stays small.

Implementations

impl Refusal

pub fn new(code: impl Into<String>, message: impl Into<String>) -> Self

A refusal with code, carrying the class the vocabulary gives it; a code this crate does not list gets ErrorClass::Permanent.

pub fn with_detail(self, detail: RefusalDetail) -> Self

pub fn invalid_params( field: impl Into<String>, message: impl Into<String>, ) -> Self

invalid_params naming field.

pub fn over_limit( field: impl Into<String>, limit: u64, message: impl Into<String>, ) -> Self

invalid_params naming field and the limit it exceeded.

pub fn batch_id_reuse(field: impl Into<String>) -> Self

batch_id_reuse naming the first differing field.

pub fn model_unknown(model: impl Into<String>) -> Self

pub fn model_not_classifier( model: impl Into<String>, kind: impl Into<String>, ) -> Self

classifier/v1’s model_not_classifier.

pub fn model_not_extractor(model: impl Into<String>, kind: Option<&str>) -> Self

extractor/v1’s model_not_extractor. kind is the row’s kind, None when the row states none; the refusal never invents one.

pub fn cost_exceeded(estimate_usd: Number, max_cost_usd: Number) -> Self

pub fn account_walled() -> Self

pub fn auth_failed() -> Self

The call’s first provider call met a 401 or 403.

pub fn model_unavailable(model: impl Into<String>) -> Self

The call’s first provider call met a 404 for model.

pub fn account_limit_exhausted() -> Self

The call’s first provider call met Workers AI code 3036.

pub fn account_not_entitled() -> Self

The call’s first provider call met Workers AI code 5035, 5016 or 3023.

pub fn batch_in_progress(retry_after_ms: u64) -> Self

pub fn field(&self) -> Option<&str>

The refused field, if the detail names one.

Trait Implementations

impl Clone for Refusal

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 Refusal

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Refusal

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Refusal

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

Formats the value using the given formatter.

impl Error for Refusal

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl PartialEq for Refusal

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Refusal

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 Refusal