Struct libp2p_core::muxing::SingletonMuxer

source · [−]

pub struct SingletonMuxer<TSocket> { /* private fields */ }

Expand description

Implementation of StreamMuxer that allows only one substream on top of a connection, yielding the connection itself.

Applying this muxer on a connection doesn’t read or write any data on the connection itself. Most notably, no protocol is negotiated.

Implementations

source

impl<TSocket> SingletonMuxer<TSocket>

source

pub fn new(inner: TSocket, endpoint: Endpoint) -> Self

Creates a new SingletonMuxer.

If endpoint is Dialer, then only one outbound substream will be permitted. If endpoint is Listener, then only one inbound substream will be permitted.

Trait Implementations

source

impl<TSocket> StreamMuxer for SingletonMuxer<TSocket>where
TSocket: AsyncRead + AsyncWrite + Unpin,

type Substream = TSocket

Type of the object that represents the raw substream where data can be read and written.

type Error = Error

Error type of the muxer

source

fn poll_inbound(
self: Pin<&mut Self>,
_: &mut Context<'_>
) -> Poll<Result<Self::Substream, Self::Error>>

Poll for new inbound substreams. Read more

source

fn poll_outbound(
self: Pin<&mut Self>,
_: &mut Context<'_>
) -> Poll<Result<Self::Substream, Self::Error>>

Poll for a new, outbound substream.

source

fn poll_close(
self: Pin<&mut Self>,
_cx: &mut Context<'_>
) -> Poll<Result<(), Error>>

Poll to close this StreamMuxer. Read more

source

fn poll(
self: Pin<&mut Self>,
_: &mut Context<'_>
) -> Poll<Result<StreamMuxerEvent, Self::Error>>

Poll to allow the underlying connection to make progress. Read more

Auto Trait Implementations

impl<TSocket> !RefUnwindSafe for SingletonMuxer<TSocket>

impl<TSocket> Send for SingletonMuxer<TSocket>where
TSocket: Send,

impl<TSocket> !Sync for SingletonMuxer<TSocket>

impl<TSocket> Unpin for SingletonMuxer<TSocket>where
TSocket: Unpin,

impl<TSocket> UnwindSafe for SingletonMuxer<TSocket>where
TSocket: UnwindSafe,

Blanket Implementations

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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<T> for T

type Output = T

Should always be Self

source

impl<S> StreamMuxerExt for Swhere
S: StreamMuxer,

source

fn poll_inbound_unpin(
 &mut self,
 cx: &mut Context<'_>
) -> Poll<Result<Self::Substream, Self::Error>>where
 Self: Unpin,

Convenience function for calling StreamMuxer::poll_inbound for StreamMuxers that are Unpin.

source

fn poll_outbound_unpin(
 &mut self,
 cx: &mut Context<'_>
) -> Poll<Result<Self::Substream, Self::Error>>where
 Self: Unpin,

Convenience function for calling StreamMuxer::poll_outbound for StreamMuxers that are Unpin.

source

fn poll_unpin(
 &mut self,
 cx: &mut Context<'_>
) -> Poll<Result<StreamMuxerEvent, Self::Error>>where
 Self: Unpin,

Convenience function for calling StreamMuxer::poll for StreamMuxers that are Unpin.

source

fn poll_close_unpin(
 &mut self,
 cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>where
 Self: Unpin,

Convenience function for calling StreamMuxer::poll_close for StreamMuxers that are Unpin.

source

fn next_inbound(&mut self) -> NextInbound<'_, Self>ⓘNotable traits for NextInbound<'a, S>`impl<'a, S> Future for NextInbound<'a, S>where S: StreamMuxer + Unpin, type Output = Result<S::Substream, S::Error>;`

Returns a future that resolves to the next inbound Substream opened by the remote.

source

fn next_outbound(&mut self) -> NextOutbound<'_, Self>ⓘNotable traits for NextOutbound<'a, S>`impl<'a, S> Future for NextOutbound<'a, S>where S: StreamMuxer + Unpin, type Output = Result<S::Substream, S::Error>;`

Returns a future that opens a new outbound Substream with the remote.

source

fn close(self) -> Close<Self>ⓘNotable traits for Close<S>`impl<S> Future for Close<S>where S: StreamMuxer + Unpin, type Output = Result<(), S::Error>;`

Returns a future for closing this StreamMuxer.

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct libp2p_core::muxing::SingletonMuxer

Implementations

impl<TSocket> SingletonMuxer<TSocket>

pub fn new(inner: TSocket, endpoint: Endpoint) -> Self

Trait Implementations

impl<TSocket> StreamMuxer for SingletonMuxer<TSocket>where TSocket: AsyncRead + AsyncWrite + Unpin,

type Substream = TSocket

type Error = Error

fn poll_inbound( self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<Result<Self::Substream, Self::Error>>

fn poll_outbound( self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<Result<Self::Substream, Self::Error>>

fn poll_close( self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Result<(), Error>>

fn poll( self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<Result<StreamMuxerEvent, Self::Error>>

Auto Trait Implementations

impl<TSocket> !RefUnwindSafe for SingletonMuxer<TSocket>

impl<TSocket> Send for SingletonMuxer<TSocket>where TSocket: Send,

impl<TSocket> !Sync for SingletonMuxer<TSocket>

impl<TSocket> Unpin for SingletonMuxer<TSocket>where TSocket: Unpin,

impl<TSocket> UnwindSafe for SingletonMuxer<TSocket>where TSocket: UnwindSafe,

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<S> StreamMuxerExt for Swhere S: StreamMuxer,

fn poll_inbound_unpin( &mut self, cx: &mut Context<'_>) -> Poll<Result<Self::Substream, Self::Error>>where Self: Unpin,

fn poll_outbound_unpin( &mut self, cx: &mut Context<'_>) -> Poll<Result<Self::Substream, Self::Error>>where Self: Unpin,

fn poll_unpin( &mut self, cx: &mut Context<'_>) -> Poll<Result<StreamMuxerEvent, Self::Error>>where Self: Unpin,

fn poll_close_unpin( &mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>where Self: Unpin,

fn next_inbound(&mut self) -> NextInbound<'_, Self>ⓘNotable traits for NextInbound<'a, S>impl<'a, S> Future for NextInbound<'a, S>where S: StreamMuxer + Unpin, type Output = Result<S::Substream, S::Error>;

fn next_outbound(&mut self) -> NextOutbound<'_, Self>ⓘNotable traits for NextOutbound<'a, S>impl<'a, S> Future for NextOutbound<'a, S>where S: StreamMuxer + Unpin, type Output = Result<S::Substream, S::Error>;

fn close(self) -> Close<Self>ⓘNotable traits for Close<S>impl<S> Future for Close<S>where S: StreamMuxer + Unpin, type Output = Result<(), S::Error>;

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

type Error = Infallible

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

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

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

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

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

fn vzip(self) -> V

impl<TSocket> StreamMuxer for SingletonMuxer<TSocket>where
TSocket: AsyncRead + AsyncWrite + Unpin,

fn poll_inbound(
self: Pin<&mut Self>,
_: &mut Context<'_>
) -> Poll<Result<Self::Substream, Self::Error>>

fn poll_outbound(
self: Pin<&mut Self>,
_: &mut Context<'_>
) -> Poll<Result<Self::Substream, Self::Error>>

fn poll_close(
self: Pin<&mut Self>,
_cx: &mut Context<'_>
) -> Poll<Result<(), Error>>

fn poll(
self: Pin<&mut Self>,
_: &mut Context<'_>
) -> Poll<Result<StreamMuxerEvent, Self::Error>>

impl<TSocket> Send for SingletonMuxer<TSocket>where
TSocket: Send,

impl<TSocket> Unpin for SingletonMuxer<TSocket>where
TSocket: Unpin,

impl<TSocket> UnwindSafe for SingletonMuxer<TSocket>where
TSocket: UnwindSafe,

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

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

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

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

impl<S> StreamMuxerExt for Swhere
S: StreamMuxer,

fn poll_inbound_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<Self::Substream, Self::Error>>where
Self: Unpin,

fn poll_outbound_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<Self::Substream, Self::Error>>where
Self: Unpin,

fn poll_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<StreamMuxerEvent, Self::Error>>where
Self: Unpin,

fn poll_close_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>where
Self: Unpin,

fn next_inbound(&mut self) -> NextInbound<'_, Self>ⓘNotable traits for NextInbound<'a, S>`impl<'a, S> Future for NextInbound<'a, S>where S: StreamMuxer + Unpin, type Output = Result<S::Substream, S::Error>;`

fn next_outbound(&mut self) -> NextOutbound<'_, Self>ⓘNotable traits for NextOutbound<'a, S>`impl<'a, S> Future for NextOutbound<'a, S>where S: StreamMuxer + Unpin, type Output = Result<S::Substream, S::Error>;`

fn close(self) -> Close<Self>ⓘNotable traits for Close<S>`impl<S> Future for Close<S>where S: StreamMuxer + Unpin, type Output = Result<(), S::Error>;`

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

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

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