Struct RlpxSatelliteStream 

pub struct RlpxSatelliteStream<St, Primary> { /* private fields */ }

Available on crate feature network only.

A Stream and Sink type that acts as a wrapper around a primary RLPx subprotocol (e.g. “eth”) EthStream and can also handle additional subprotocols.

Implementations

impl<St, Primary> RlpxSatelliteStream<St, Primary>

pub fn install_protocol<F, Proto>( &mut self, cap: &Capability, f: F, ) -> Result<(), UnsupportedCapabilityError>

where F: FnOnce(ProtocolConnection) -> Proto, Proto: Stream<Item = BytesMut> + Send + 'static,

Installs a new protocol on top of the raw p2p stream.

This accepts a closure that receives a ProtocolConnection that will yield messages for the given capability.

pub const fn primary(&self) -> &Primary

Returns the primary protocol.

pub const fn primary_mut(&mut self) -> &mut Primary

Returns mutable access to the primary protocol.

pub const fn inner(&self) -> &P2PStream<St>

Returns the underlying P2PStream.

pub const fn inner_mut(&mut self) -> &mut P2PStream<St>

Returns mutable access to the underlying P2PStream.

pub fn into_inner(self) -> P2PStream<St>

Consumes this type and returns the wrapped P2PStream.

Trait Implementations

impl<St, Primary> Debug for RlpxSatelliteStream<St, Primary>

where St: Debug, Primary: Debug,

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

Formats the value using the given formatter.

impl<N> From<RlpxSatelliteStream<ECIESStream<TcpStream>, EthStream<ProtocolProxy, N>>> for EthRlpxConnection<N>

where N: NetworkPrimitives,

fn from( conn: RlpxSatelliteStream<ECIESStream<TcpStream>, EthStream<ProtocolProxy, N>>, ) -> EthRlpxConnection<N>

Converts to this type from the input type.

impl<St, Primary, T> Sink<T> for RlpxSatelliteStream<St, Primary>

where St: Stream<Item = Result<BytesMut, Error>> + Sink<Bytes, Error = Error> + Unpin, Primary: Sink<T> + Unpin, P2PStreamError: Into<<Primary as Sink<T>>::Error>,

type Error = <Primary as Sink<T>>::Error

The type of value produced by the sink when an error occurs.

fn poll_ready( self: Pin<&mut RlpxSatelliteStream<St, Primary>>, cx: &mut Context<'_>, ) -> Poll<Result<(), <RlpxSatelliteStream<St, Primary> as Sink<T>>::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send( self: Pin<&mut RlpxSatelliteStream<St, Primary>>, item: T, ) -> Result<(), <RlpxSatelliteStream<St, Primary> as Sink<T>>::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush( self: Pin<&mut RlpxSatelliteStream<St, Primary>>, cx: &mut Context<'_>, ) -> Poll<Result<(), <RlpxSatelliteStream<St, Primary> as Sink<T>>::Error>>

Flush any remaining output from this sink.

fn poll_close( self: Pin<&mut RlpxSatelliteStream<St, Primary>>, cx: &mut Context<'_>, ) -> Poll<Result<(), <RlpxSatelliteStream<St, Primary> as Sink<T>>::Error>>

Flush any remaining output and close this sink, if necessary.

impl<St, Primary, PrimaryErr> Stream for RlpxSatelliteStream<St, Primary>

where St: Stream<Item = Result<BytesMut, Error>> + Sink<Bytes, Error = Error> + Unpin, Primary: TryStream<Error = PrimaryErr> + Unpin, P2PStreamError: Into<PrimaryErr>,

type Item = Result<<Primary as TryStream>::Ok, <Primary as TryStream>::Error>

Values yielded by the stream.

fn poll_next( self: Pin<&mut RlpxSatelliteStream<St, Primary>>, cx: &mut Context<'_>, ) -> Poll<Option<<RlpxSatelliteStream<St, Primary> as Stream>::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.