Enum openraft::error::RaftError

pub enum RaftError<NID, E = Infallible>
where
    NID: NodeId,
{
    APIError(E),
    Fatal(Fatal<NID>),
}

RaftError is returned by API methods of Raft.

It is either a Fatal error indicating that Raft is no longer running, such as underlying IO error, or an API error E.

Variants

APIError(E)

Fatal(Fatal<NID>)

Implementations

impl<NID, E> RaftError<NID, E>

where NID: NodeId, E: Debug,

pub fn api_error(&self) -> Option<&E>

Return a reference to Self::APIError.

pub fn into_api_error(self) -> Option<E>

Try to convert self to APIError.

pub fn fatal(&self) -> Option<&Fatal<NID>>

Return a reference to Self::Fatal.

pub fn into_fatal(self) -> Option<Fatal<NID>>

Try to convert self to Fatal error.

pub fn forward_to_leader<N>(&self) -> Option<&ForwardToLeader<NID, N>>

where N: Node, E: TryAsRef<ForwardToLeader<NID, N>>,

Return a reference to ForwardToLeader if Self::APIError contains it.

pub fn into_forward_to_leader<N>(self) -> Option<ForwardToLeader<NID, N>>

where N: Node, E: TryInto<ForwardToLeader<NID, N>>,

Try to convert self to ForwardToLeader error if APIError is a ForwardToLeader error.

Trait Implementations

impl<NID, E: Clone> Clone for RaftError<NID, E>

where NID: NodeId + Clone,

fn clone(&self) -> RaftError<NID, E>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<NID, E: Debug> Debug for RaftError<NID, E>

where NID: NodeId + Debug,

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

Formats the value using the given formatter.

impl<'de, NID, E> Deserialize<'de> for RaftError<NID, E>

where NID: NodeId, E: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<NID, E> Display for RaftError<NID, E>

where NID: NodeId, E: Display, Fatal<NID>: Display,

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

Formats the value using the given formatter.

impl<NID, E> Error for RaftError<NID, E>

where NID: NodeId, E: Error, Fatal<NID>: Error, Self: Debug + Display,

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

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.

impl<NID, E> From<Fatal<NID>> for RaftError<NID, E>

where NID: NodeId,

fn from(source: Fatal<NID>) -> Self

Converts to this type from the input type.

impl<NID, E> From<StorageError<NID>> for RaftError<NID, E>

where NID: NodeId,

fn from(se: StorageError<NID>) -> Self

Converts to this type from the input type.

impl<NID, E: PartialEq> PartialEq for RaftError<NID, E>

where NID: NodeId + PartialEq,

fn eq(&self, other: &RaftError<NID, E>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<NID, E> Serialize for RaftError<NID, E>

where NID: NodeId, E: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<NID, N, E> TryAsRef<ForwardToLeader<NID, N>> for RaftError<NID, E>

where NID: NodeId, N: Node, E: Debug + TryAsRef<ForwardToLeader<NID, N>>,

fn try_as_ref(&self) -> Option<&ForwardToLeader<NID, N>>

Try to convert this type into a shared reference of T.

impl<NID, E: Eq> Eq for RaftError<NID, E>

where NID: NodeId + Eq,

impl<NID, E> StructuralPartialEq for RaftError<NID, E>

where NID: NodeId,