Enum Message

pub enum Message {
    Subscribe(Subscribe),
    Announcement(Announcement),
    Info(Info),
    Ping(Ping),
    Pong {
        zeroes: ZeroBytes,
    },
}

Message payload. These are the messages peers send to each other.

Variants

Subscribe(Subscribe)

Subscribe to gossip messages matching the filter and time range.

Announcement(Announcement)

Gossip announcement. These messages are relayed to peers, and filtered using Message::Subscribe.

Info(Info)

Informational message. These messages are sent between peers for information and do not need to be acted upon. They can be safely ignored, though handling them can be useful for the user.

Ping(Ping)

Ask a connected peer for a Pong.

Used to check if the remote peer is responsive, or a side-effect free way to keep a connection alive.

Pong

Response to Ping message.

Fields

zeroes: ZeroBytes

The pong payload.

Implementations

impl Message

pub fn announcement( node: PublicKey, message: impl Into<AnnouncementMessage>, signature: Signature, ) -> Message

pub fn node<G>(message: NodeAnnouncement, signer: &Device<G>) -> Message

where G: Signer<Signature>,

pub fn inventory<G>( message: InventoryAnnouncement, signer: &Device<G>, ) -> Message

where G: Signer<Signature>,

pub fn subscribe(filter: Filter, since: Timestamp, until: Timestamp) -> Message

pub fn log(&self, level: Level, remote: &PublicKey, link: Link)

impl Message

pub const MAX_SIZE: u16 = 65_533u16

The maximum supported message size in bytes.

pub fn type_id(&self) -> u16

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.

impl Decode for Message

fn decode(buf: &mut impl Buf) -> Result<Message, Error>

impl Encode for Message

fn encode(&self, buf: &mut impl BufMut)

impl From<Announcement> for Message

fn from(ann: Announcement) -> Message

Converts to this type from the input type.

impl From<Info> for Message

fn from(info: Info) -> Message

Converts to this type from the input type.

impl Ord for Message

fn cmp(&self, other: &Message) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Message

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

fn partial_cmp(&self, other: &Message) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Message

impl StructuralPartialEq for Message