ErrorDetails

rama::http::grpc::protobuf::types

Struct ErrorDetails 

#[non_exhaustive]
pub struct ErrorDetails { /* private fields */ }
Expand description

Groups the standard error messages structs. Provides associated functions and methods to setup and edit each error message independently. Used when extracting error details from crate::Status, and when creating a crate::Status with error details.

Implementations§

§

impl ErrorDetails

pub fn new() -> ErrorDetails

Generates an ErrorDetails struct with all fields set to None.

pub fn with_retry_info(retry_delay: Option<Duration>) -> ErrorDetails

Generates an ErrorDetails struct with RetryInfo details and remaining fields set to None.

pub fn with_debug_info( stack_entries: impl Into<Vec<String>>, detail: impl Into<String>, ) -> ErrorDetails

Generates an ErrorDetails struct with DebugInfo details and remaining fields set to None.

pub fn with_quota_failure( violations: impl Into<Vec<QuotaViolation>>, ) -> ErrorDetails

Generates an ErrorDetails struct with QuotaFailure details and remaining fields set to None.

pub fn with_quota_failure_violation( subject: impl Into<String>, description: impl Into<String>, ) -> ErrorDetails

Generates an ErrorDetails struct with QuotaFailure details (one QuotaViolation set) and remaining fields set to None.

pub fn with_error_info( reason: impl Into<String>, domain: impl Into<String>, metadata: impl Into<HashMap<String, String>>, ) -> ErrorDetails

Generates an ErrorDetails struct with ErrorInfo details and remaining fields set to None.

pub fn with_precondition_failure( violations: impl Into<Vec<PreconditionViolation>>, ) -> ErrorDetails

Generates an ErrorDetails struct with PreconditionFailure details and remaining fields set to None.

pub fn with_precondition_failure_violation( violation_type: impl Into<String>, subject: impl Into<String>, description: impl Into<String>, ) -> ErrorDetails

Generates an ErrorDetails struct with PreconditionFailure details (one PreconditionViolation set) and remaining fields set to None.

pub fn with_bad_request( field_violations: impl Into<Vec<FieldViolation>>, ) -> ErrorDetails

Generates an ErrorDetails struct with BadRequest details and remaining fields set to None.

pub fn with_bad_request_violation( field: impl Into<String>, description: impl Into<String>, ) -> ErrorDetails

Generates an ErrorDetails struct with BadRequest details (one FieldViolation set) and remaining fields set to None.

pub fn with_request_info( request_id: impl Into<String>, serving_data: impl Into<String>, ) -> ErrorDetails

Generates an ErrorDetails struct with RequestInfo details and remaining fields set to None.

pub fn with_resource_info( resource_type: impl Into<String>, resource_name: impl Into<String>, owner: impl Into<String>, description: impl Into<String>, ) -> ErrorDetails

Generates an ErrorDetails struct with ResourceInfo details and remaining fields set to None.

pub fn with_help(links: impl Into<Vec<HelpLink>>) -> ErrorDetails

Generates an ErrorDetails struct with Help details and remaining fields set to None.

Generates an ErrorDetails struct with Help details (one HelpLink set) and remaining fields set to None.

pub fn with_localized_message( locale: impl Into<String>, message: impl Into<String>, ) -> ErrorDetails

Generates an ErrorDetails struct with LocalizedMessage details and remaining fields set to None.

pub fn retry_info(&self) -> Option<&RetryInfo>

Get RetryInfo details, if any.

pub fn debug_info(&self) -> Option<&DebugInfo>

Get DebugInfo details, if any.

pub fn quota_failure(&self) -> Option<&QuotaFailure>

Get QuotaFailure details, if any.

pub fn error_info(&self) -> Option<&ErrorInfo>

Get ErrorInfo details, if any.

pub fn precondition_failure(&self) -> Option<&PreconditionFailure>

Get PreconditionFailure details, if any.

pub fn bad_request(&self) -> Option<&BadRequest>

Get BadRequest details, if any.

pub fn request_info(&self) -> Option<&RequestInfo>

Get RequestInfo details, if any.

pub fn resource_info(&self) -> Option<&ResourceInfo>

Get ResourceInfo details, if any.

pub fn help(&self) -> Option<&Help>

Get Help details, if any.

pub fn localized_message(&self) -> Option<&LocalizedMessage>

Get LocalizedMessage details, if any.

pub fn set_retry_info( &mut self, retry_delay: Option<Duration>, ) -> &mut ErrorDetails

Set RetryInfo details. Can be chained with other .set_ and .add_ ErrorDetails methods.

pub fn set_debug_info( &mut self, stack_entries: impl Into<Vec<String>>, detail: impl Into<String>, ) -> &mut ErrorDetails

Set DebugInfo details. Can be chained with other .set_ and .add_ ErrorDetails methods.

pub fn set_quota_failure( &mut self, violations: impl Into<Vec<QuotaViolation>>, ) -> &mut ErrorDetails

Set QuotaFailure details. Can be chained with other .set_ and .add_ ErrorDetails methods.

pub fn add_quota_failure_violation( &mut self, subject: impl Into<String>, description: impl Into<String>, ) -> &mut ErrorDetails

Adds a QuotaViolation to QuotaFailure details. Sets QuotaFailure details if it is not set yet. Can be chained with other .set_ and .add_ ErrorDetails methods.

pub fn has_quota_failure_violations(&self) -> bool

Returns true if QuotaFailure is set and its violations vector is not empty, otherwise returns false.

pub fn set_error_info( &mut self, reason: impl Into<String>, domain: impl Into<String>, metadata: impl Into<HashMap<String, String>>, ) -> &mut ErrorDetails

Set ErrorInfo details. Can be chained with other .set_ and .add_ ErrorDetails methods.

pub fn set_precondition_failure( &mut self, violations: impl Into<Vec<PreconditionViolation>>, ) -> &mut ErrorDetails

Set PreconditionFailure details. Can be chained with other .set_ and .add_ ErrorDetails methods.

pub fn add_precondition_failure_violation( &mut self, violation_type: impl Into<String>, subject: impl Into<String>, description: impl Into<String>, ) -> &mut ErrorDetails

Adds a PreconditionViolation to PreconditionFailure details. Sets PreconditionFailure details if it is not set yet. Can be chained with other .set_ and .add_ ErrorDetails methods.

pub fn has_precondition_failure_violations(&self) -> bool

Returns true if PreconditionFailure is set and its violations vector is not empty, otherwise returns false.

pub fn set_bad_request( &mut self, violations: impl Into<Vec<FieldViolation>>, ) -> &mut ErrorDetails

Set BadRequest details. Can be chained with other .set_ and .add_ ErrorDetails methods.

pub fn add_bad_request_violation( &mut self, field: impl Into<String>, description: impl Into<String>, ) -> &mut ErrorDetails

Adds a FieldViolation to BadRequest details. Sets BadRequest details if it is not set yet. Can be chained with other .set_ and .add_ ErrorDetails methods.

pub fn has_bad_request_violations(&self) -> bool

Returns true if BadRequest is set and its field_violations vector is not empty, otherwise returns false.

pub fn set_request_info( &mut self, request_id: impl Into<String>, serving_data: impl Into<String>, ) -> &mut ErrorDetails

Set RequestInfo details. Can be chained with other .set_ and .add_ ErrorDetails methods.

pub fn set_resource_info( &mut self, resource_type: impl Into<String>, resource_name: impl Into<String>, owner: impl Into<String>, description: impl Into<String>, ) -> &mut ErrorDetails

Set ResourceInfo details. Can be chained with other .set_ and .add_ ErrorDetails methods.

pub fn set_help(&mut self, links: impl Into<Vec<HelpLink>>) -> &mut ErrorDetails

Set Help details. Can be chained with other .set_ and .add_ ErrorDetails methods.

Adds a HelpLink to Help details. Sets Help details if it is not set yet. Can be chained with other .set_ and .add_ ErrorDetails methods.

Returns true if Help is set and its links vector is not empty, otherwise returns false.

pub fn set_localized_message( &mut self, locale: impl Into<String>, message: impl Into<String>, ) -> &mut ErrorDetails

Set LocalizedMessage details. Can be chained with other .set_ and .add_ ErrorDetails methods.

Trait Implementations§

§

impl Clone for ErrorDetails

§

fn clone(&self) -> ErrorDetails

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
§

impl Debug for ErrorDetails

§

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

Formats the value using the given formatter. Read more
§

impl Default for ErrorDetails

§

fn default() -> ErrorDetails

Returns the “default value” for a type. Read more

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
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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.

§

impl<T> FromRef<T> for T
where T: Clone,

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<T> FutureExt for T

§

fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
§

fn with_current_context(self) -> WithContext<Self> ⓘ

Attaches the current Context to this type, returning a WithContext wrapper. Read more
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> IntoRequest<T> for T

§

fn into_request(self) -> Request<T>

Wrap the input message T in a rama_grpc::Request
§

impl<L> LayerExt<L> for L

§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
§

impl<T, U> RamaFrom<T> for U
where U: From<T>,

§

fn rama_from(value: T) -> U

§

impl<T, U, CrateMarker> RamaInto<U, CrateMarker> for T
where U: RamaFrom<T, CrateMarker>,

§

fn rama_into(self) -> U

§

impl<T, U> RamaTryFrom<T> for U
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

§

fn rama_try_from(value: T) -> Result<U, <U as RamaTryFrom<T>>::Error>

§

impl<T, U, CrateMarker> RamaTryInto<U, CrateMarker> for T
where U: RamaTryFrom<T, CrateMarker>,

§

type Error = <U as RamaTryFrom<T, CrateMarker>>::Error

§

fn rama_try_into(self) -> Result<U, <U as RamaTryFrom<T, CrateMarker>>::Error>

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more