Enum ProtocolError 

#[non_exhaustive]
pub enum ProtocolError {
    SerializationFailed(String),
    DeserializationFailed(String),
    MessageTooLarge {
        size: usize,
        max_size: usize,
    },
    ChunkTooLarge {
        size: usize,
        max_size: usize,
    },
    AddressMismatch {
        expected: XorName,
        actual: XorName,
    },
    StorageFailed(String),
    PaymentFailed(String),
    QuoteFailed(String),
    Internal(String),
    ClientUpdateRequired {
        client_settlement_version: u32,
        min_settlement_version: u32,
    },
    StorerUpdateRequired {
        client_settlement_version: u32,
        node_settlement_version: u32,
    },
}

Errors that can occur during protocol operations.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

SerializationFailed(String)

Message serialization failed.

DeserializationFailed(String)

Message deserialization failed.

MessageTooLarge

Wire message exceeds the maximum allowed size.

Fields

size: usize

Actual size of the message in bytes.

max_size: usize

Maximum allowed size.

ChunkTooLarge

Chunk exceeds maximum size.

Fields

size: usize

Size of the chunk in bytes.

max_size: usize

Maximum allowed size.

AddressMismatch

Content address mismatch (hash(content) != address).

Fields

expected: XorName

Expected address.

actual: XorName

Actual address computed from content.

StorageFailed(String)

Storage operation failed.

PaymentFailed(String)

Payment verification failed.

QuoteFailed(String)

Quote generation failed.

Internal(String)

Internal error.

ClientUpdateRequired

The client settles payments under rules this node no longer accepts, so no quote was issued.

Refused at quote time on purpose. A client that pays under superseded rules produces an on-chain payment every storer will reject, and that payment cannot be refunded, so the only useful place to stop it is before the client spends anything.

Appended last so existing variants keep their wire discriminants. A peer old enough not to know this variant cannot be sent it: it would have had to send a V2 request to earn it, and only builds that carry this variant do that.

Fields

client_settlement_version: u32

Settlement version the client declared.

min_settlement_version: u32

Oldest settlement version this node will quote for.

StorerUpdateRequired

This node settles under older rules than the client, so it declined to quote rather than promise to accept a payment it may not recognise.

The mirror image of Self::ClientUpdateRequired, and deliberately a separate variant: it is not a verdict about the client, and a client that receives it should quietly use a different storer rather than tell its user anything. During a client-first rollout most of the fleet is briefly in this state, so treating it as a client fault would strand every up-to-date user.

Fields

client_settlement_version: u32

Settlement version the client declared.

node_settlement_version: u32

Newest settlement version this node understands.

Trait Implementations

impl Clone for ProtocolError

fn clone(&self) -> ProtocolError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProtocolError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProtocolError

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ProtocolError

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

Formats the value using the given formatter.

impl Eq for ProtocolError

impl Error for ProtocolError

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

Returns 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 PartialEq for ProtocolError

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ProtocolError

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ProtocolError