Skip to main content

ModelFailure

Struct ModelFailure 

Source
pub struct ModelFailure { /* private fields */ }
Expand description

Provider-neutral terminal model failure.

Implementations§

Source§

impl ModelFailure

Source

pub fn internal_adapter_failure() -> Self

Creates a fixed internal adapter failure.

Source

pub fn new( code: ModelFailureCode, message: impl Into<String>, retry: RetryClass, ) -> Result<Self, ModelStreamValueError>

Creates a bounded technical failure without an internal source chain.

§Errors

Returns an error when message is empty, exceeds 4 KiB, or contains a null character.

Source

pub fn safe( code: ModelFailureCode, message: impl Into<String>, retry: RetryClass, ) -> Result<Self, ModelStreamValueError>

Creates a provider failure whose message was normalized for display.

The caller must have removed provider payload fields, bounded the text, and stripped terminal control characters before using this constructor.

§Errors

Returns an error when the normalized message violates the model failure bounds.

Source

pub fn with_metadata(self, metadata: ProtocolMetadata) -> Self

Adds bounded namespaced safe metadata.

Source

pub fn with_retry_after(self, retry_after: Duration) -> Self

Adds a provider-requested delay before this failure is retried.

Source

pub const fn code(&self) -> ModelFailureCode

Returns the stable failure code.

Source

pub fn message(&self) -> &str

Returns the English technical message.

Source

pub const fn retry(&self) -> RetryClass

Returns the retry classification.

Source

pub const fn retry_after(&self) -> Option<Duration>

Returns the provider-requested retry delay when one was supplied.

Source

pub const fn metadata(&self) -> &ProtocolMetadata

Returns safe namespaced metadata.

Source

pub const fn is_safe_diagnostic(&self) -> bool

Returns whether the message is safe to expose as provider diagnostics.

Trait Implementations§

Source§

impl Clone for ModelFailure

Source§

fn clone(&self) -> ModelFailure

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 Debug for ModelFailure

Source§

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

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

impl PartialEq for ModelFailure

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ModelFailure

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> 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 = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.