Struct RedisError

pub struct RedisError { /* private fields */ }

Represents a redis error.

For the most part you should be using the Error trait to interact with this rather than the actual struct.

Implementations

impl RedisError

Indicates a general failure in the library.

pub fn kind(&self) -> ErrorKind

Returns the kind of the error.

pub fn detail(&self) -> Option<&str>

Returns the error detail.

pub fn code(&self) -> Option<&str>

Returns the raw error code if available.

pub fn category(&self) -> &str

Returns the name of the error category for display purposes.

pub fn is_io_error(&self) -> bool

Indicates that this failure is an IO failure.

pub fn is_cluster_error(&self) -> bool

Indicates that this is a cluster error.

pub fn is_connection_refusal(&self) -> bool

Returns true if this error indicates that the connection was refused. You should generally not rely much on this function unless you are writing unit tests that want to detect if a local server is available.

pub fn is_timeout(&self) -> bool

Returns true if error was caused by I/O time out. Note that this may not be accurate depending on platform.

pub fn is_connection_dropped(&self) -> bool

Returns true if error was caused by a dropped connection.

pub fn is_unrecoverable_error(&self) -> bool

Returns true if the error is likely to not be recoverable, and the connection must be replaced.

pub fn redirect_node(&self) -> Option<(&str, u16)>

Returns the node the error refers to.

This returns (addr, slot_id).

pub fn extension_error_code(&self) -> Option<&str>

👎Deprecated: use code() instead

Returns the extension error code.

This method should not be used because every time the redis library adds support for a new error code it would disappear form this method. code() always returns the code.

Trait Implementations

impl Debug for RedisError

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

Formats the value using the given formatter.

impl Display for RedisError

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

Formats the value using the given formatter.

impl Error for RedisError

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 source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

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.

impl From<(ErrorKind, &'static str)> for RedisError

fn from(_: (ErrorKind, &'static str)) -> RedisError

Converts to this type from the input type.

impl From<(ErrorKind, &'static str, String)> for RedisError

fn from(_: (ErrorKind, &'static str, String)) -> RedisError

Converts to this type from the input type.

impl From<Elapsed> for RedisError

fn from(_: Elapsed) -> RedisError

Converts to this type from the input type.

impl From<Error> for RedisError

fn from(err: Error) -> RedisError

Converts to this type from the input type.

impl From<Error> for RedisError

fn from(err: Error) -> RedisError

Converts to this type from the input type.

impl From<FromUtf8Error> for RedisError

fn from(_: FromUtf8Error) -> RedisError

Converts to this type from the input type.

impl From<NulError> for RedisError

fn from(err: NulError) -> RedisError

Converts to this type from the input type.

impl From<ServerError> for RedisError

fn from(value: ServerError) -> RedisError

Converts to this type from the input type.

impl From<Utf8Error> for RedisError

fn from(_: Utf8Error) -> RedisError

Converts to this type from the input type.

impl PartialEq for RedisError

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.