Enum ProtocolError

pub enum ProtocolError {
    InvalidHost(String),
    InvalidKey(String),
    RemoteFailed(String),
    Unknown(String),
}

A helper type for protocol errors.

This is used to send and receive errors over the network. It is also used to serialize and deserialize errors.

It should not be sent / received over the network, as it should be sent as a ProtocolMessage::Error message. The type system should prevent this from happening.

Variants

InvalidHost(String)

InvalidKey(String)

RemoteFailed(String)

Unknown(String)

Implementations

impl ProtocolError

pub async fn send_and_bail<T, R>(self, stream: &mut T) -> Res<R>

where T: BincodeSend,

Sends the error message and shuts down the stream.

The generic parameter R represents the return type expected by the calling function. This method always returns an error, but needs to have the expected return type for the context.

Trait Implementations

impl<'__de, __Context> BorrowDecode<'__de, __Context> for ProtocolError

fn borrow_decode<__D: BorrowDecoder<'__de, Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given BorrowDecode.

impl Clone for ProtocolError

fn clone(&self) -> ProtocolError

Returns a copy 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<__Context> Decode<__Context> for ProtocolError

fn decode<__D: Decoder<Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given Decode.

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 Encode for ProtocolError

fn encode<__E: Encoder>(&self, encoder: &mut __E) -> Result<(), EncodeError>

Encode a given type.

impl PartialEq for ProtocolError

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

impl StructuralPartialEq for ProtocolError