Struct libp2p_core::connection::Connection

source · [−]

pub struct Connection<TMuxer, THandler> where
    TMuxer: StreamMuxer,
    THandler: ConnectionHandler<Substream = Substream<TMuxer>>,  { /* private fields */ }

Expand description

A multiplexed connection to a peer with an associated ConnectionHandler.

Implementations

source

impl<TMuxer, THandler> Connection<TMuxer, THandler> where
TMuxer: StreamMuxer,
THandler: ConnectionHandler<Substream = Substream<TMuxer>>,

source

pub fn new(muxer: TMuxer, handler: THandler) -> Self

Builds a new Connection from the given substream multiplexer and connection handler.

source

pub fn handler(&self) -> &THandler

Returns a reference to the ConnectionHandler

source

pub fn handler_mut(&mut self) -> &mut THandler

Returns a mutable reference to the ConnectionHandler

source

pub fn inject_event(&mut self, event: THandler::InEvent)

Notifies the connection handler of an event.

source

pub fn close(self) -> Close<TMuxer>ⓘNotable traits for Close<TMuxer>`impl<TMuxer> Future for Close<TMuxer> where TMuxer: StreamMuxer, type Output = Result<(), IoError>;`

Begins an orderly shutdown of the connection, returning a Future that resolves when connection shutdown is complete.

source

pub fn poll(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<Event<THandler::OutEvent>, ConnectionError<THandler::Error>>>

Polls the connection for events produced by the associated handler as a result of I/O activity on the substream multiplexer.

Trait Implementations

source

impl<TMuxer, THandler> Debug for Connection<TMuxer, THandler> where
TMuxer: StreamMuxer,
THandler: ConnectionHandler<Substream = Substream<TMuxer>> + Debug,

source

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

Formats the value using the given formatter. Read more

source

impl<TMuxer, THandler> Unpin for Connection<TMuxer, THandler> where
TMuxer: StreamMuxer,
THandler: ConnectionHandler<Substream = Substream<TMuxer>>,

Auto Trait Implementations

impl<TMuxer, THandler> RefUnwindSafe for Connection<TMuxer, THandler> where
 THandler: RefUnwindSafe,
 TMuxer: RefUnwindSafe,
 <THandler as ConnectionHandler>::OutboundOpenInfo: RefUnwindSafe,
 <TMuxer as StreamMuxer>::OutboundSubstream: RefUnwindSafe,

impl<TMuxer, THandler> Send for Connection<TMuxer, THandler> where
 THandler: Send,
 TMuxer: Send + Sync,
 <THandler as ConnectionHandler>::OutboundOpenInfo: Send,
 <TMuxer as StreamMuxer>::OutboundSubstream: Send,

impl<TMuxer, THandler> Sync for Connection<TMuxer, THandler> where
 THandler: Sync,
 TMuxer: Send + Sync,
 <THandler as ConnectionHandler>::OutboundOpenInfo: Sync,
 <TMuxer as StreamMuxer>::OutboundSubstream: Sync,

impl<TMuxer, THandler> UnwindSafe for Connection<TMuxer, THandler> where
 THandler: UnwindSafe,
 TMuxer: RefUnwindSafe,
 <THandler as ConnectionHandler>::OutboundOpenInfo: UnwindSafe + RefUnwindSafe,
 <TMuxer as StreamMuxer>::OutboundSubstream: UnwindSafe + RefUnwindSafe,

Blanket Implementations

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · source

pub 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<T> for T

type Output = T

Should always be Self

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

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

source

Struct libp2p_core::connection::Connection

Implementations

impl<TMuxer, THandler> Connection<TMuxer, THandler> where
TMuxer: StreamMuxer,
THandler: ConnectionHandler<Substream = Substream<TMuxer>>,

pub fn new(muxer: TMuxer, handler: THandler) -> Self

pub fn handler(&self) -> &THandler

pub fn handler_mut(&mut self) -> &mut THandler

pub fn inject_event(&mut self, event: THandler::InEvent)

pub fn close(self) -> Close<TMuxer>ⓘNotable traits for Close<TMuxer>`impl<TMuxer> Future for Close<TMuxer> where TMuxer: StreamMuxer, type Output = Result<(), IoError>;`

pub fn poll(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<Event<THandler::OutEvent>, ConnectionError<THandler::Error>>>

Trait Implementations

impl<TMuxer, THandler> Debug for Connection<TMuxer, THandler> where
TMuxer: StreamMuxer,
THandler: ConnectionHandler<Substream = Substream<TMuxer>> + Debug,

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

impl<TMuxer, THandler> Unpin for Connection<TMuxer, THandler> where
TMuxer: StreamMuxer,
THandler: ConnectionHandler<Substream = Substream<TMuxer>>,

Auto Trait Implementations

impl<TMuxer, THandler> RefUnwindSafe for Connection<TMuxer, THandler> where
    THandler: RefUnwindSafe,
    TMuxer: RefUnwindSafe,
    <THandler as ConnectionHandler>::OutboundOpenInfo: RefUnwindSafe,
    <TMuxer as StreamMuxer>::OutboundSubstream: RefUnwindSafe,

impl<TMuxer, THandler> Send for Connection<TMuxer, THandler> where
    THandler: Send,
    TMuxer: Send + Sync,
    <THandler as ConnectionHandler>::OutboundOpenInfo: Send,
    <TMuxer as StreamMuxer>::OutboundSubstream: Send,

impl<TMuxer, THandler> Sync for Connection<TMuxer, THandler> where
    THandler: Sync,
    TMuxer: Send + Sync,
    <THandler as ConnectionHandler>::OutboundOpenInfo: Sync,
    <TMuxer as StreamMuxer>::OutboundSubstream: Sync,

impl<TMuxer, THandler> UnwindSafe for Connection<TMuxer, THandler> where
    THandler: UnwindSafe,
    TMuxer: RefUnwindSafe,
    <THandler as ConnectionHandler>::OutboundOpenInfo: UnwindSafe + RefUnwindSafe,
    <TMuxer as StreamMuxer>::OutboundSubstream: UnwindSafe + RefUnwindSafe,

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

impl<T> Same<T> for T

type Output = T

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

type Error = Infallible

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

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

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

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

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

pub fn vzip(self) -> V

Struct libp2p_core::connection::Connection

Implementations

impl<TMuxer, THandler> Connection<TMuxer, THandler> where TMuxer: StreamMuxer, THandler: ConnectionHandler<Substream = Substream<TMuxer>>,

pub fn new(muxer: TMuxer, handler: THandler) -> Self

pub fn handler(&self) -> &THandler

pub fn handler_mut(&mut self) -> &mut THandler

pub fn inject_event(&mut self, event: THandler::InEvent)

pub fn close(self) -> Close<TMuxer>ⓘNotable traits for Close<TMuxer>impl<TMuxer> Future for Close<TMuxer> where TMuxer: StreamMuxer, type Output = Result<(), IoError>;

pub fn poll( self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<Event<THandler::OutEvent>, ConnectionError<THandler::Error>>>

Trait Implementations

impl<TMuxer, THandler> Debug for Connection<TMuxer, THandler> where TMuxer: StreamMuxer, THandler: ConnectionHandler<Substream = Substream<TMuxer>> + Debug,

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

impl<TMuxer, THandler> Unpin for Connection<TMuxer, THandler> where TMuxer: StreamMuxer, THandler: ConnectionHandler<Substream = Substream<TMuxer>>,

Auto Trait Implementations

impl<TMuxer, THandler> RefUnwindSafe for Connection<TMuxer, THandler> where THandler: RefUnwindSafe, TMuxer: RefUnwindSafe, <THandler as ConnectionHandler>::OutboundOpenInfo: RefUnwindSafe, <TMuxer as StreamMuxer>::OutboundSubstream: RefUnwindSafe,

impl<TMuxer, THandler> Send for Connection<TMuxer, THandler> where THandler: Send, TMuxer: Send + Sync, <THandler as ConnectionHandler>::OutboundOpenInfo: Send, <TMuxer as StreamMuxer>::OutboundSubstream: Send,

impl<TMuxer, THandler> Sync for Connection<TMuxer, THandler> where THandler: Sync, TMuxer: Send + Sync, <THandler as ConnectionHandler>::OutboundOpenInfo: Sync, <TMuxer as StreamMuxer>::OutboundSubstream: Sync,

impl<TMuxer, THandler> UnwindSafe for Connection<TMuxer, THandler> where THandler: UnwindSafe, TMuxer: RefUnwindSafe, <THandler as ConnectionHandler>::OutboundOpenInfo: UnwindSafe + RefUnwindSafe, <TMuxer as StreamMuxer>::OutboundSubstream: UnwindSafe + RefUnwindSafe,

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

impl<T> Same<T> for T

type Output = T

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

type Error = Infallible

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

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

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

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

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

pub fn vzip(self) -> V

impl<TMuxer, THandler> Connection<TMuxer, THandler> where
TMuxer: StreamMuxer,
THandler: ConnectionHandler<Substream = Substream<TMuxer>>,

pub fn close(self) -> Close<TMuxer>ⓘNotable traits for Close<TMuxer>`impl<TMuxer> Future for Close<TMuxer> where TMuxer: StreamMuxer, type Output = Result<(), IoError>;`

pub fn poll(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<Event<THandler::OutEvent>, ConnectionError<THandler::Error>>>

impl<TMuxer, THandler> Debug for Connection<TMuxer, THandler> where
TMuxer: StreamMuxer,
THandler: ConnectionHandler<Substream = Substream<TMuxer>> + Debug,

impl<TMuxer, THandler> Unpin for Connection<TMuxer, THandler> where
TMuxer: StreamMuxer,
THandler: ConnectionHandler<Substream = Substream<TMuxer>>,

impl<TMuxer, THandler> RefUnwindSafe for Connection<TMuxer, THandler> where
THandler: RefUnwindSafe,
TMuxer: RefUnwindSafe,
<THandler as ConnectionHandler>::OutboundOpenInfo: RefUnwindSafe,
<TMuxer as StreamMuxer>::OutboundSubstream: RefUnwindSafe,

impl<TMuxer, THandler> Send for Connection<TMuxer, THandler> where
THandler: Send,
TMuxer: Send + Sync,
<THandler as ConnectionHandler>::OutboundOpenInfo: Send,
<TMuxer as StreamMuxer>::OutboundSubstream: Send,

impl<TMuxer, THandler> Sync for Connection<TMuxer, THandler> where
THandler: Sync,
TMuxer: Send + Sync,
<THandler as ConnectionHandler>::OutboundOpenInfo: Sync,
<TMuxer as StreamMuxer>::OutboundSubstream: Sync,

impl<TMuxer, THandler> UnwindSafe for Connection<TMuxer, THandler> where
THandler: UnwindSafe,
TMuxer: RefUnwindSafe,
<THandler as ConnectionHandler>::OutboundOpenInfo: UnwindSafe + RefUnwindSafe,
<TMuxer as StreamMuxer>::OutboundSubstream: UnwindSafe + RefUnwindSafe,

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

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

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

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

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

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

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