Struct ErrorMessage

pub struct ErrorMessage {
    pub channel_id: ChannelId,
    pub data: String,
}

An error message to be sent to or received from a peer.

Fields

channel_id: ChannelId

The channel ID involved in the error.

All-0s indicates a general error unrelated to a specific channel, after which all channels with the sending peer should be closed.

data: String

A possibly human-readable error description.

The string should be sanitized before it is used (e.g., emitted to logs or printed to stdout). Otherwise, a well crafted error message may trigger a security vulnerability in the terminal emulator or the logging subsystem.

Trait Implementations

impl Clone for ErrorMessage

fn clone(&self) -> ErrorMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ErrorMessage

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

Formats the value using the given formatter.

impl PartialEq for ErrorMessage

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

fn read<R>(r: &mut R) -> Result<ErrorMessage, DecodeError>

where R: Read,

Reads a Self in from the given Read.

impl Writeable for ErrorMessage

fn write<W>(&self, w: &mut W) -> Result<(), Error>

where W: Writer,

Writes self out to the given Writer.

fn encode(&self) -> Vec<u8>

Writes self out to a Vec<u8>.

fn serialized_length(&self) -> usize

Gets the length of this object after it has been serialized. This can be overridden to optimize cases where we prepend an object with its length.

impl Eq for ErrorMessage

impl StructuralPartialEq for ErrorMessage