pub enum TransportEvent<TUpgr, TErr> {
    NewAddress {
        listener_id: ListenerId,
        listen_addr: Multiaddr,
    },
    AddressExpired {
        listener_id: ListenerId,
        listen_addr: Multiaddr,
    },
    Incoming {
        listener_id: ListenerId,
        upgrade: TUpgr,
        local_addr: Multiaddr,
        send_back_addr: Multiaddr,
    },
    ListenerClosed {
        listener_id: ListenerId,
        reason: Result<(), TErr>,
    },
    ListenerError {
        listener_id: ListenerId,
        error: TErr,
    },
}
Expand description

Event produced by Transports.

Variants§

§

NewAddress

Fields

§listener_id: ListenerId

The listener that is listening on the new address.

§listen_addr: Multiaddr

The new address that is being listened on.

A new address is being listened on.

§

AddressExpired

Fields

§listener_id: ListenerId

The listener that is no longer listening on the address.

§listen_addr: Multiaddr

The new address that is being listened on.

An address is no longer being listened on.

§

Incoming

Fields

§listener_id: ListenerId

The listener that produced the upgrade.

§upgrade: TUpgr

The produced upgrade.

§local_addr: Multiaddr

Local connection address.

§send_back_addr: Multiaddr

Address used to send back data to the incoming client.

A connection is incoming on one of the listeners.

§

ListenerClosed

Fields

§listener_id: ListenerId

The ID of the listener that closed.

§reason: Result<(), TErr>

Reason for the closure. Contains Ok(()) if the stream produced None, or Err if the stream produced an error.

A listener closed.

§

ListenerError

Fields

§listener_id: ListenerId

The ID of the listener that errored.

§error: TErr

The error value.

A listener errored.

The listener will continue to be polled for new events and the event is for informational purposes only.

Implementations§

source§

impl<TUpgr, TErr> TransportEvent<TUpgr, TErr>

source

pub fn map_upgrade<U>( self, map: impl FnOnce(TUpgr) -> U ) -> TransportEvent<U, TErr>

In case this TransportEvent is an upgrade, apply the given function to the upgrade and produce another transport event based the the function’s result.

source

pub fn map_err<E>( self, map_err: impl FnOnce(TErr) -> E ) -> TransportEvent<TUpgr, E>

In case this TransportEvent is an ListenerError, or ListenerClosed apply the given function to the error and produce another transport event based on the function’s result.

source

pub fn is_upgrade(&self) -> bool

Returns true if this is an Incoming transport event.

source

pub fn into_incoming(self) -> Option<(TUpgr, Multiaddr)>

Try to turn this transport event into the upgrade parts of the incoming connection.

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

source

pub fn is_new_address(&self) -> bool

Returns true if this is a TransportEvent::NewAddress.

source

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

Try to turn this transport event into the new Multiaddr.

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

source

pub fn is_address_expired(&self) -> bool

Returns true if this is an TransportEvent::AddressExpired.

source

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

Try to turn this transport event into the expire Multiaddr.

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

source

pub fn is_listener_error(&self) -> bool

Returns true if this is an TransportEvent::ListenerError transport event.

source

pub fn into_listener_error(self) -> Option<TErr>

Try to turn this transport event into the listener error.

Returns None if the event is not actually a TransportEvent::ListenerError`, otherwise the error.

Trait Implementations§

source§

impl<TUpgr, TErr: Debug> Debug for TransportEvent<TUpgr, TErr>

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<TUpgr, TErr> RefUnwindSafe for TransportEvent<TUpgr, TErr>
where TErr: RefUnwindSafe, TUpgr: RefUnwindSafe,

§

impl<TUpgr, TErr> Send for TransportEvent<TUpgr, TErr>
where TErr: Send, TUpgr: Send,

§

impl<TUpgr, TErr> Sync for TransportEvent<TUpgr, TErr>
where TErr: Sync, TUpgr: Sync,

§

impl<TUpgr, TErr> Unpin for TransportEvent<TUpgr, TErr>
where TErr: Unpin, TUpgr: Unpin,

§

impl<TUpgr, TErr> UnwindSafe for TransportEvent<TUpgr, TErr>
where TErr: UnwindSafe, TUpgr: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more