Enum libp2p_core::transport::ListenerEvent

pub enum ListenerEvent<T> {
    NewAddress(Multiaddr),
    Upgrade {
        upgrade: T,
        listen_addr: Multiaddr,
        remote_addr: Multiaddr,
    },
    AddressExpired(Multiaddr),
}

Event produced by Transport::Listeners.

Transports are expected to produce Upgrade events only for listen addresses which have previously been announced via a NewAddress event and which have not been invalidated by an AddressExpired event yet.

Variants

NewAddress(Multiaddr)

The transport is listening on a new additional Multiaddr.

Upgrade

An upgrade, consisting of the upgrade future, the listener address and the remote address.

Fields of Upgrade

upgrade: T

The upgrade.

listen_addr: Multiaddr

The listening address which produced this upgrade.

remote_addr: Multiaddr

The remote address which produced this upgrade.

AddressExpired(Multiaddr)

A Multiaddr is no longer used for listening.

Methods

impl<T> ListenerEvent<T>

pub fn map<U>(self, f: impl FnOnce(T) -> U) -> ListenerEvent<U>

In case this ListenerEvent is an upgrade, apply the given function to the upgrade and multiaddress and produce another listener event based the the function's result.

pub fn is_upgrade(&self) -> bool

Returns true if this is an Upgrade listener event.

pub fn into_upgrade(self) -> Option<(T, Multiaddr)>

Try to turn this listener event into upgrade parts.

Returns None if the event is not actually an upgrade, otherwise the upgrade and the remote address.

pub fn is_new_address(&self) -> bool

Returns true if this is a NewAddress listener event.

pub fn into_new_address(self) -> Option<Multiaddr>

Try to turn this listener event into the NewAddress part.

Returns None if the event is not actually a NewAddress, otherwise the address.

pub fn is_address_expired(&self) -> bool

Returns true if this is an AddressExpired listener event.

pub fn into_address_expired(self) -> Option<Multiaddr>

Try to turn this listener event into the AddressExpired part.

Returns None if the event is not actually a AddressExpired, otherwise the address.

Trait Implementations

impl<T: Clone> Clone for ListenerEvent<T>

fn clone(&self) -> ListenerEvent<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: PartialEq> PartialEq<ListenerEvent<T>> for ListenerEvent<T>

fn eq(&self, other: &ListenerEvent<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ListenerEvent<T>) -> bool

This method tests for !=.

impl<T: Debug> Debug for ListenerEvent<T>

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

Formats the value using the given formatter.