Enum foca::Error

pub enum Error {
    DataTooBig,
    NotUndead,
    SameIdentity,
    NotConnected,
    IncompleteProbeCycle,
    DataFromOurselves,
    IndirectForOurselves,
    MalformedPacket,
    Encode(Error),
    Decode(Error),
    CustomBroadcast(Error),
    InvalidConfig,
}

This type represents all possible errors operating a Foca instance.

Variants

DataTooBig

Emitted whenever Foca receives a byte slice larger than the configured limit (crate::Config::max_packet_size).

Doesn’t affect Foca’s state.

NotUndead

Attempt to crate::Foca::reuse_down_identity when not needed.

Doesn’t affect Foca’s state.

SameIdentity

Attempt to crate::Foca::change_identity with the same identity.

Doesn’t affect Foca’s state.

NotConnected

Expected to be connected when reaching this point. Sentinel error to detect integration bugs.

Must not happen under normal circumstances.

IncompleteProbeCycle

Reached the end of the probe cycle but expected steps didn’t happen. Bug in the runtime/scheduling mechanism most likely.

Foca tries to resume normal operations after emitting this error, but any occurance of it is a sign that something is not behaving as expected

Must not happen under normal circumstances.

DataFromOurselves

Received data where the sender has the same id as ourselves.

There’s likely a member submitting wrong/manually-crafted packets.

IndirectForOurselves

Data contains a message supposed to reach us via indirect means.

There’s likely a member submitting wrong/manually-crafted packets.

MalformedPacket

Data is in an unexpected format.

Doesn’t affect Foca’s state.

Encode(Error)

Wraps crate::Codec’s encode_* failures. Shouldn’t happen under normal circumstances unless using a broken codec.

Might have left Foca in a inconsistent state.

Decode(Error)

Wraps crate::Codec’s decode_* failures.

Can happen during normal operation when receiving junk data.

CustomBroadcast(Error)

Wraps crate::BroadcastHandler failures.

Doesn’t affect Foca’s state.

InvalidConfig

Configuration change not allowed.

Doesn’t affact Foca’s state.

See crate::Foca::set_config.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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 Error

fn eq(&self, other: &Self) -> 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.