Struct AnnouncementData 

pub struct AnnouncementData { /* private fields */ }

Structure containing data used for an on-chain announcement. That is an optional decapsulated multiaddress (with the /p2p/{peer_id} suffix removed) and mandatory keybinding KeyBinding.

NOTE: This currently supports only announcing of a single multiaddress

Implementations

impl AnnouncementData

pub fn new( key_binding: KeyBinding, multiaddress: Option<Multiaddr>, ) -> Result<Self, GeneralError>

Constructs structure from optional multiaddress and also KeyBinding.

The multiaddress must not be empty if present. It should be the external address of the node. It may contain a trailing PeerId (encapsulated multiaddr) or come without. If the peerId is present, it must match with the keybinding.

pub fn multiaddress(&self) -> Option<&Multiaddr>

Returns the optional multiaddress associated with this announcement.

Note that the returned multiaddress is always decapsulated (= without the /p2p/<peer_id> suffix)

pub fn key_binding(&self) -> &KeyBinding

Returns the key binding with this announcement.

Trait Implementations

impl Clone for AnnouncementData

fn clone(&self) -> AnnouncementData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AnnouncementData

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

Formats the value using the given formatter.

impl Display for AnnouncementData

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

Formats the value using the given formatter.

impl PartialEq for AnnouncementData

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

impl StructuralPartialEq for AnnouncementData