Enum cola::DecodeError

pub enum DecodeError {
    ChecksumFailed,
    DifferentProtocol {
        encoded_on: ProtocolVersion,
        decoding_on: ProtocolVersion,
    },
    InvalidData,
}

The type of error that can occur when decodeing an EncodedReplica.

Variants

ChecksumFailed

This error occurs when the internal checksum of the EncodedReplica fails.

This typically means that the EncodedReplica was corrupted during transmission.

DifferentProtocol

Fields

encoded_on: ProtocolVersion

The ProtocolVersion of cola on the machine that created the EncodedReplica.

decoding_on: ProtocolVersion

The ProtocolVersion of cola on the machine that is trying to decode the EncodedReplica.

This error occurs when the machine that created the EncodedReplica and the one that is trying to decode it are using two incompatible versions of cola.

InvalidData

This error is an umbrella variant that encompasses all other errors that can occur when the binary data wrapped by the EncodedReplica cannot be decoded into a Replica.

This is returned when the checksum and protocol version checks both succeed, and yet the data is still invalid. The only way this can occur in practice is if the EncodedReplica passed to decode was deserialized from a byte vector that was not the result of serializing an EncodedReplica.

As long as you’re not doing that (and you shouldn’t be) this variant can be ignored.

Trait Implementations

impl Clone for DecodeError

fn clone(&self) -> DecodeError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DecodeError

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

Formats the value using the given formatter.

impl Display for DecodeError

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

Formats the value using the given formatter.

impl Error for DecodeError

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 PartialEq for DecodeError

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

impl StructuralPartialEq for DecodeError