Struct ProviderDetail 

pub struct ProviderDetail(/* private fields */);

The endpoint’s own sentence about why it refused, sanitized.

Why this exists beside ErrorCode

A code says which family a failure belongs to. It cannot say what was wrong with the request, and for the one family where that is the adopter’s own bug — a malformed request — the difference between “the provider is down” and “your function schema is missing properties” is the difference between waiting and fixing. Finding the second took putting a proxy between the process and the endpoint to read a body the runtime had already read and thrown away.

What it is not

It is not shown to a user and it is not in ProviderError’s Display, which keeps its promise that what it renders is safe to log unconditionally. This is the vendor’s words about a request this library sent: normally about the request’s shape, and in principle able to quote a value from it. An adapter passes it through the same Redactor the code goes through, and construction here drops control characters, collapses runs of whitespace and truncates on a character boundary.

Implementations

impl ProviderDetail

pub fn new(raw: impl AsRef<str>) -> Self

Sanitizes and truncates raw into a detail.

use turnframe_provider::error::ProviderDetail;

let detail = ProviderDetail::new("Invalid schema for function 'x':\n  missing properties");
assert_eq!(
    detail.as_str(),
    "Invalid schema for function 'x': missing properties"
);

pub fn as_str(&self) -> &str

The sanitized text.

pub fn is_empty(&self) -> bool

Whether anything survived sanitizing.

Trait Implementations

impl Clone for ProviderDetail

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 ProviderDetail

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProviderDetail

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ProviderDetail

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

Formats the value using the given formatter.

impl Eq for ProviderDetail

impl Hash for ProviderDetail

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ProviderDetail

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for ProviderDetail

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ProviderDetail

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for ProviderDetail

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 ProviderDetail