Struct ConnectionError 

pub struct ConnectionError {
    pub message: String,
    pub recoverable: bool,
    pub url: Option<String>,
    pub auth_user: Option<String>,
    pub hint: Option<String>,
}

Error information passed to the on_error handler.

Fields

message: String

Human-readable error message.

recoverable: bool

Whether this error is recoverable (i.e. auto-reconnect may succeed).

url: Option<String>

KalamDB base URL associated with the failed connection, when known.

auth_user: Option<String>

Auth user associated with the failed connection, when known.

hint: Option<String>

Actionable remediation hint for the caller, when known.

Implementations

impl ConnectionError

pub fn new(message: impl Into<String>, recoverable: bool) -> ConnectionError

Create a new connection error.

pub fn with_url(self, url: impl Into<String>) -> ConnectionError

Attach the connection URL when available.

pub fn with_auth_user(self, auth_user: impl Into<String>) -> ConnectionError

Attach the auth user when available.

pub fn with_hint(self, hint: impl Into<String>) -> ConnectionError

Attach an actionable remediation hint when available.

Trait Implementations

impl Clone for ConnectionError

fn clone(&self) -> ConnectionError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConnectionError

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

Formats the value using the given formatter.

impl Display for ConnectionError

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

Formats the value using the given formatter.