Enum ProtocolError 

pub enum ProtocolError<'a> {
    InvalidHost(&'a str),
    InvalidKey(&'a str),
    RemoteFailed(&'a str),
    Unknown(&'a str),
}

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(&'a str)

InvalidKey(&'a str)

RemoteFailed(&'a str)

Unknown(&'a str)

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, 'a, __Context> BorrowDecode<'__de, __Context> for ProtocolError<'a>

where '__de: 'a,

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

Attempt to decode this type with the given BorrowDecode.

impl<'a> Clone for ProtocolError<'a>

fn clone(&self) -> ProtocolError<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ProtocolError<'a>

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

Formats the value using the given formatter.

impl<'de: 'a, 'a> Deserialize<'de> for ProtocolError<'a>

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

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

Encode a given type.

impl<'a> PartialEq for ProtocolError<'a>

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> Eq for ProtocolError<'a>

impl<'a> StructuralPartialEq for ProtocolError<'a>