Trait RecvStream

pub trait RecvStream: Send {
    // Required methods
    fn recv_bytes(
        &mut self,
        len: usize,
    ) -> impl Future<Output = Result<Bytes>> + Send;
    fn recv_bytes_exact(
        &mut self,
        len: usize,
    ) -> impl Future<Output = Result<Bytes>> + Send;
    fn recv<const L: usize>(
        &mut self,
    ) -> impl Future<Output = Result<[u8; L]>> + Send;
    fn stop(&mut self, code: VarInt) -> Result<()>;
    fn id(&self) -> u64;
}

An abstract iroh::endpoint::RecvStream.

Required Methods

fn recv_bytes( &mut self, len: usize, ) -> impl Future<Output = Result<Bytes>> + Send

Receive up to len bytes from the stream, directly into a Bytes.

fn recv_bytes_exact( &mut self, len: usize, ) -> impl Future<Output = Result<Bytes>> + Send

Receive exactly len bytes from the stream, directly into a Bytes.

This will return an error if the stream ends before len bytes are read.

Note that this is different from recv_bytes, which will return fewer bytes if the stream ends.

fn recv<const L: usize>( &mut self, ) -> impl Future<Output = Result<[u8; L]>> + Send

Receive exactly L bytes from the stream, directly into a [u8; L].

fn stop(&mut self, code: VarInt) -> Result<()>

Stop the stream with the given error code.

fn id(&self) -> u64

Get the stream id.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl RecvStream for Bytes

async fn recv_bytes(&mut self, len: usize) -> Result<Bytes>

async fn recv_bytes_exact(&mut self, len: usize) -> Result<Bytes>

async fn recv<const L: usize>(&mut self) -> Result<[u8; L]>

fn stop(&mut self, _code: VarInt) -> Result<()>

fn id(&self) -> u64

impl RecvStream for RecvStream

async fn recv_bytes(&mut self, len: usize) -> Result<Bytes>

async fn recv_bytes_exact(&mut self, len: usize) -> Result<Bytes>

async fn recv<const L: usize>(&mut self) -> Result<[u8; L]>

fn stop(&mut self, code: VarInt) -> Result<()>

fn id(&self) -> u64

impl<R: RecvStream> RecvStream for &mut R

async fn recv_bytes(&mut self, len: usize) -> Result<Bytes>

async fn recv_bytes_exact(&mut self, len: usize) -> Result<Bytes>

async fn recv<const L: usize>(&mut self) -> Result<[u8; L]>

fn stop(&mut self, code: VarInt) -> Result<()>

fn id(&self) -> u64

Implementors

impl<R: RecvStreamSpecific> RecvStream for AsyncReadRecvStream<R>