Struct openraft::error::PayloadTooLarge

pub struct PayloadTooLarge { /* private fields */ }

Error indicating that an RPC is too large and cannot be sent.

This is a retryable error: A RaftNetwork implementation returns this error to inform Openraft to divide an AppendEntriesRequest into smaller chunks. Openraft will immediately retry sending in smaller chunks. If the request cannot be divided(contains only one entry), Openraft interprets it as Unreachable.

A hint can be provided to help Openraft in splitting the request.

The application should also set an appropriate value for Config::max_payload_entries to avoid returning this error if possible.

Example:

impl<C: RaftTypeConfig> RaftNetwork<C> for MyNetwork {
    fn append_entries(&self,
            rpc: AppendEntriesRequest<C>,
            option: RPCOption
    ) -> Result<_, RPCError<C::NodeId, C::Node, RaftError<C::NodeId>>> {
        if rpc.entries.len() > 10 {
            return Err(PayloadTooLarge::new_entries_hint(10).into());
        }
        // ...
    }
}

Implementations

impl PayloadTooLarge

pub fn new_entries_hint(entries_hint: u64) -> Self

Create a new PayloadTooLarge, with entries hint, without the causing error.

pub fn with_source_error(self, e: &(impl Error + 'static)) -> Self

Set the source error that causes this PayloadTooLarge error.

pub fn action(&self) -> RPCTypes

pub fn entries_hint(&self) -> u64

Get the hint for entries number.

Trait Implementations

impl Clone for PayloadTooLarge

fn clone(&self) -> PayloadTooLarge

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PayloadTooLarge

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PayloadTooLarge

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PayloadTooLarge

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

Formats the value using the given formatter.

impl Error for PayloadTooLarge

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: NodeId, N: Node, E: Error> From<PayloadTooLarge> for RPCError<NID, N, E>

fn from(source: PayloadTooLarge) -> Self

Converts to this type from the input type.

impl PartialEq for PayloadTooLarge

fn eq(&self, other: &PayloadTooLarge) -> 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 Serialize for PayloadTooLarge

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for PayloadTooLarge

impl StructuralPartialEq for PayloadTooLarge