Skip to main content

XdsError

Enum XdsError 

Source
pub enum XdsError {
Show 18 variants InvalidTypeUrl { type_url: String, reason: String, }, ResourceNotFound { type_url: String, name: String, }, VersionMismatch { type_url: String, name: String, expected: String, actual: String, }, InvalidResource { type_url: String, name: String, reason: String, }, CacheError { message: String, source: Option<Box<dyn Error + Send + Sync>>, }, WatchError { message: String, }, SnapshotIncomplete { missing_types: Vec<String>, }, EncodingError { type_url: String, message: String, }, DecodingError { type_url: String, message: String, }, TransportError { message: String, source: Option<Box<dyn Error + Send + Sync>>, }, StreamClosed { reason: String, }, NackReceived { node_id: String, type_url: String, nonce: String, error_message: String, }, Timeout { operation: String, }, Shutdown, RateLimited { message: String, }, Internal { message: String, source: Option<Box<dyn Error + Send + Sync>>, }, WatchClosed { watch_id: u64, }, Configuration(String),
}
Expand description

Comprehensive error type for xDS operations.

This error type is designed to:

  • Cover all failure modes without using panics
  • Properly convert to tonic::Status for gRPC responses
  • Provide detailed error messages for debugging
  • Support error chaining via the source field

§Example

use xds_core::XdsError;

fn validate_resource(name: &str) -> Result<(), XdsError> {
    if name.is_empty() {
        return Err(XdsError::InvalidResource {
            type_url: "type.googleapis.com/envoy.config.cluster.v3.Cluster".to_string(),
            name: name.to_string(),
            reason: "resource name cannot be empty".to_string(),
        });
    }
    Ok(())
}

Variants§

§

InvalidTypeUrl

Malformed or unknown type URL.

Fields

§type_url: String

The invalid type URL.

§reason: String

Reason why the type URL is invalid.

§

ResourceNotFound

Requested resource doesn’t exist in the cache.

Fields

§type_url: String

The type URL of the resource.

§name: String

The name of the resource.

§

VersionMismatch

Version conflict during update.

Fields

§type_url: String

The type URL of the resource.

§name: String

The name of the resource.

§expected: String

Expected version.

§actual: String

Actual version received.

§

InvalidResource

Resource validation failed.

Fields

§type_url: String

The type URL of the resource.

§name: String

The name of the resource.

§reason: String

Reason for validation failure.

§

CacheError

Cache operation failed.

Fields

§message: String

Description of the cache error.

§source: Option<Box<dyn Error + Send + Sync>>

Optional underlying error.

§

WatchError

Watch creation or notification failed.

Fields

§message: String

Description of the watch error.

§

SnapshotIncomplete

Snapshot is incomplete - missing required resource types.

Fields

§missing_types: Vec<String>

List of missing type URLs.

§

EncodingError

Protobuf encoding failed.

Fields

§type_url: String

The type URL being encoded.

§message: String

Error message.

§

DecodingError

Protobuf decoding failed.

Fields

§type_url: String

The type URL being decoded.

§message: String

Error message.

§

TransportError

gRPC transport error.

Fields

§message: String

Error message.

§source: Option<Box<dyn Error + Send + Sync>>

Optional underlying error.

§

StreamClosed

Client stream closed unexpectedly.

Fields

§reason: String

Reason for stream closure.

§

NackReceived

Client rejected configuration (NACK).

Fields

§node_id: String

The node ID that sent the NACK.

§type_url: String

The type URL that was rejected.

§nonce: String

The nonce of the rejected response.

§error_message: String

Error message from the client.

§

Timeout

Operation timed out.

Fields

§operation: String

Description of the operation that timed out.

§

Shutdown

Server is shutting down.

§

RateLimited

Too many requests (rate limited).

Fields

§message: String

Rate limit message.

§

Internal

Unexpected internal error.

Fields

§message: String

Error message.

§source: Option<Box<dyn Error + Send + Sync>>

Optional underlying error.

§

WatchClosed

Watch subscription was closed.

Fields

§watch_id: u64

ID of the closed watch.

§

Configuration(String)

Configuration error.

Implementations§

Source§

impl XdsError

Source

pub fn internal<E>(message: impl Into<String>, source: E) -> Self
where E: Error + Send + Sync + 'static,

Create an internal error from any error type.

Source

pub fn cache<E>(message: impl Into<String>, source: E) -> Self
where E: Error + Send + Sync + 'static,

Create a cache error from any error type.

Source

pub fn transport<E>(message: impl Into<String>, source: E) -> Self
where E: Error + Send + Sync + 'static,

Create a transport error from any error type.

Trait Implementations§

Source§

impl Debug for XdsError

Source§

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

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

impl Display for XdsError

Source§

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

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

impl Error for XdsError

Source§

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

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

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

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

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. Read more
Source§

impl From<XdsError> for Status

Convert to tonic::Status for gRPC responses.

This implementation maps each error variant to an appropriate gRPC status code.

Source§

fn from(err: XdsError) -> Self

Converts to this type from the input type.

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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