Enum actix_raft::messages::ClientError

pub enum ClientError<D: AppData, R: AppDataResponse, E: AppError> {
    Internal,
    Application(E),
    ForwardToLeader {
        payload: ClientPayload<D, R, E>,
        leader: Option<NodeId>,
    },
}

Error variants which may arise while handling client requests.

Variants

Internal

Some error which has taken place internally in Raft.

Application(E)

An application specific error.

ForwardToLeader

The Raft node returning this error is not the Raft leader.

Forward the payload to the specified leader. If the leader is unknown, it is up to the application to determine how to handle. The payload can be buffered in the app until the new leader is known, or it can be returned to the client as an error and the client can be instructed to send to a new random node until the leader is known.

The process of electing a new leader is usually a very fast process in Raft, so buffering the client payload until the new leader is known should not cause a lot of overhead.

Fields of ForwardToLeader

payload: ClientPayload<D, R, E>

The original payload which this error is associated with.

leader: Option<NodeId>

The ID of the current Raft leader, if known.

Trait Implementations

impl<D: Debug + AppData, R: Debug + AppDataResponse, E: Debug + AppError> Debug for ClientError<D, R, E>

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

Formats the value using the given formatter.

impl<'de, D: AppData, R: AppDataResponse, E: AppError> Deserialize<'de> for ClientError<D, R, E> where
    E: AppError,
    D: AppData,
    R: AppDataResponse,
    E: AppError, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<D: AppData, R: AppDataResponse, E: AppError> Display for ClientError<D, R, E>

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

Formats the value using the given formatter.

impl<D: AppData, R: AppDataResponse, E: AppError> Error for ClientError<D, R, E>

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

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred.

fn description(&self) -> &str

Deprecated since 1.42.0:

use the Display impl or to_string()

if let Err(e) = "xc".parse::<u32>() { // Print e itself, no need for description(). eprintln!("Error: {}", e); }

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

Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl<D: AppData, R: AppDataResponse, E: AppError> Serialize for ClientError<D, R, E> where
    E: AppError,
    D: AppData,
    R: AppDataResponse,
    E: AppError, 

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

Serialize this value into the given Serde serializer.