Enum SyncError

pub enum SyncError {
    UnexpectedBehaviour(String),
    InvalidEncoding(String),
    Critical(String),
}

Errors which can occur during sync sessions.

1. Critical system failures (ie. bug in p2panda code or sync implementation, sync implementation did not follow “2. Phase Flow” requirements, lack of system resources, etc.)
2. Unexpected Behaviour (ie. remote peer abruptly disconnected, error which got correctly caught in sync implementation, etc.)

Variants

UnexpectedBehaviour(String)

Error due to unexpected (buggy or malicious) behaviour of the remote peer.

Indicates that the sync protocol was not correctly followed, for example due to unexpected or missing messages, etc.

Can be used by a backend to re-attempt syncing with this peer or down-grading it in priority, potentially deny-listing if communication failed too often.

InvalidEncoding(String)

Error due to invalid encoding of a message sent by remote peer.

Note that this error is intended for receiving messages from remote peers which we can’t decode properly. If we fail with encoding our own messages we should rather consider this an Critical error type, as it likely means that there’s a buggy implementation.

Critical(String)

Critical error due to system failure on our end.

This indicates that our system is running out of resources (storage layer failure etc.) or we have a buggy implementation.

Trait Implementations

impl Debug for SyncError

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

Formats the value using the given formatter.

impl Display for SyncError

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

Formats the value using the given formatter.

impl Error for SyncError

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 From<Error> for SyncError

Converts critical I/O error (which occurs during codec stream handling) into SyncError.

This is usually a critical system failure indicating an implementation bug or lacking resources on the user’s machine.

See Encoder or Decoder Error trait type in tokio’s codec for more information: https://docs.rs/tokio-util/latest/tokio_util/codec/trait.Decoder.html#associatedtype.Error

fn from(err: Error) -> Self

Converts to this type from the input type.

impl PartialEq for SyncError

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for SyncError