Struct libp2p_core::connection::EstablishedConnection

source · [−]

pub struct EstablishedConnection<'a, TInEvent> { /* private fields */ }

Expand description

An established connection in a pool.

Implementations

source

impl<TInEvent> EstablishedConnection<'_, TInEvent>

source

pub fn connected(&self) -> &Connected

source

pub fn endpoint(&self) -> &ConnectedPoint

Returns information about the connected endpoint.

source

pub fn peer_id(&self) -> PeerId

Returns the identity of the connected peer.

source

pub fn id(&self) -> ConnectionId

Returns the local connection ID.

source

pub fn notify_handler(&mut self, event: TInEvent) -> Result<(), TInEvent>

(Asynchronously) sends an event to the connection handler.

If the handler is not ready to receive the event, either because it is busy or the connection is about to close, the given event is returned with an Err.

If execution of this method is preceded by successful execution of poll_ready_notify_handler without another intervening execution of notify_handler, it only fails if the connection is now about to close.

source

pub fn poll_ready_notify_handler(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<(), ()>>

Checks if notify_handler is ready to accept an event.

Returns Ok(()) if the handler is ready to receive an event via notify_handler.

Returns Err(()) if the background task associated with the connection is terminating and the connection is about to close.

source

pub fn start_close(self)

Initiates a graceful close of the connection.

Has no effect if the connection is already closing.

Trait Implementations

source

impl<TInEvent> Debug for EstablishedConnection<'_, TInEvent> where
TInEvent: Debug,

source

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl<'a, TInEvent> !RefUnwindSafe for EstablishedConnection<'a, TInEvent>

impl<'a, TInEvent> Send for EstablishedConnection<'a, TInEvent> where
TInEvent: Send,

impl<'a, TInEvent> Sync for EstablishedConnection<'a, TInEvent> where
TInEvent: Send,

impl<'a, TInEvent> Unpin for EstablishedConnection<'a, TInEvent>

impl<'a, TInEvent> !UnwindSafe for EstablishedConnection<'a, TInEvent>

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::EstablishedConnection

Implementations

impl<TInEvent> EstablishedConnection<'_, TInEvent>

pub fn connected(&self) -> &Connected

pub fn endpoint(&self) -> &ConnectedPoint

pub fn peer_id(&self) -> PeerId

pub fn id(&self) -> ConnectionId

pub fn notify_handler(&mut self, event: TInEvent) -> Result<(), TInEvent>

pub fn poll_ready_notify_handler(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<(), ()>>

pub fn start_close(self)

Trait Implementations

impl<TInEvent> Debug for EstablishedConnection<'_, TInEvent> where
TInEvent: Debug,

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

Auto Trait Implementations

impl<'a, TInEvent> !RefUnwindSafe for EstablishedConnection<'a, TInEvent>

impl<'a, TInEvent> Send for EstablishedConnection<'a, TInEvent> where
TInEvent: Send,

impl<'a, TInEvent> Sync for EstablishedConnection<'a, TInEvent> where
TInEvent: Send,

impl<'a, TInEvent> Unpin for EstablishedConnection<'a, TInEvent>

impl<'a, TInEvent> !UnwindSafe for EstablishedConnection<'a, TInEvent>

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::EstablishedConnection

Implementations

impl<TInEvent> EstablishedConnection<'_, TInEvent>

pub fn connected(&self) -> &Connected

pub fn endpoint(&self) -> &ConnectedPoint

pub fn peer_id(&self) -> PeerId

pub fn id(&self) -> ConnectionId

pub fn notify_handler(&mut self, event: TInEvent) -> Result<(), TInEvent>

pub fn poll_ready_notify_handler( &mut self, cx: &mut Context<'_>) -> Poll<Result<(), ()>>

pub fn start_close(self)

Trait Implementations

impl<TInEvent> Debug for EstablishedConnection<'_, TInEvent> where TInEvent: Debug,

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

Auto Trait Implementations

impl<'a, TInEvent> !RefUnwindSafe for EstablishedConnection<'a, TInEvent>

impl<'a, TInEvent> Send for EstablishedConnection<'a, TInEvent> where TInEvent: Send,

impl<'a, TInEvent> Sync for EstablishedConnection<'a, TInEvent> where TInEvent: Send,

impl<'a, TInEvent> Unpin for EstablishedConnection<'a, TInEvent>

impl<'a, TInEvent> !UnwindSafe for EstablishedConnection<'a, TInEvent>

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

pub fn poll_ready_notify_handler(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<(), ()>>

impl<TInEvent> Debug for EstablishedConnection<'_, TInEvent> where
TInEvent: Debug,

impl<'a, TInEvent> Send for EstablishedConnection<'a, TInEvent> where
TInEvent: Send,

impl<'a, TInEvent> Sync for EstablishedConnection<'a, TInEvent> where
TInEvent: Send,

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>,