Enum DestinationError 

pub enum DestinationError {
    ConnectionError {
        message: String,
        source: Option<Box<dyn Error + Send + Sync>>,
    },
    SerializationError {
        message: String,
        source: Option<Box<dyn Error + Send + Sync>>,
    },
    WriteError {
        message: String,
        retryable: bool,
        source: Option<Box<dyn Error + Send + Sync>>,
    },
    ConfigurationError {
        message: String,
        parameter: Option<String>,
    },
    CapacityError {
        message: String,
        utilization: Option<f64>,
        retry_after: Option<Duration>,
    },
    Other {
        message: String,
        retryable: bool,
        source: Option<Box<dyn Error + Send + Sync>>,
    },
}

Errors that can occur when writing to a destination.

Each error variant includes information about whether the operation is retryable and provides context for error handling and observability.

Variants

ConnectionError

Connection to the destination failed.

This is typically retryable after a backoff period. Examples include:

• Network timeouts
• DNS resolution failures
• Connection refused
• TLS handshake failures

Fields

message: String

Human-readable error message

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

The underlying connection error

SerializationError

Failed to serialize events for writing.

This is typically non-retryable as it indicates a data quality issue. Examples include:

• Invalid UTF-8 sequences
• Schema validation failures
• Unsupported data types

Fields

message: String

Human-readable error message

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

The underlying serialization error

WriteError

Failed to write events to the destination.

Retryability depends on the specific cause. Examples include:

• Quota exceeded (retryable after backoff)
• Permission denied (non-retryable)
• Destination unavailable (retryable)
• Invalid data format (non-retryable)

Fields

message: String

Human-readable error message

retryable: bool

Whether this specific write error is retryable

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

The underlying error

ConfigurationError

Invalid destination configuration.

This is non-retryable and indicates a programming or configuration error. Examples include:

• Missing required configuration parameters
• Invalid connection strings
• Conflicting options

Fields

message: String

Human-readable error message

parameter: Option<String>

Configuration parameter name if applicable

CapacityError

Destination capacity exceeded.

This signals backpressure and should pause writes. Examples include:

• Write buffer full
• Rate limit exceeded
• Disk space exhausted
• Memory limit reached

Fields

message: String

Human-readable error message

utilization: Option<f64>

Current capacity utilization (0.0 - 1.0)

retry_after: Option<Duration>

Suggested wait time before retry

Other

A generic error occurred.

Used for errors that don’t fit other categories or for wrapping destination-specific errors.

Fields

message: String

Human-readable error message

retryable: bool

Whether this error is retryable

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

The underlying error

Implementations

impl DestinationError

pub fn connection(source: impl Error + Send + Sync + 'static) -> Self

Creates a connection error from any error type.

pub fn connection_msg(message: impl Into<String>) -> Self

Creates a connection error with a custom message.

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

Creates a serialization error from any error type.

pub fn write( source: impl Error + Send + Sync + 'static, retryable: bool, ) -> Self

Creates a write error with retryability information.

pub fn write_msg(message: impl Into<String>, retryable: bool) -> Self

Creates a write error with a custom message.

pub fn configuration( message: impl Into<String>, parameter: Option<String>, ) -> Self

Creates a configuration error.

pub fn capacity( message: impl Into<String>, utilization: Option<f64>, retry_after: Option<Duration>, ) -> Self

Creates a capacity error with optional metadata.

Panics

Panics in debug builds if utilization is provided and not in range [0.0, 1.0].

pub fn other( source: impl Error + Send + Sync + 'static, retryable: bool, ) -> Self

Creates a generic error.

pub const fn is_retryable(&self) -> bool

Returns whether this error is retryable.

This helps callers implement appropriate retry strategies:

• Retryable errors should be retried with exponential backoff
• Non-retryable errors should fail fast or route to dead letter queue

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

Returns suggested wait time before retry, if applicable.

Trait Implementations

impl Debug for DestinationError

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

Formats the value using the given formatter.

impl Display for DestinationError

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

Formats the value using the given formatter.

impl Error for DestinationError

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.