Embassy
embassy-net

Crates

git

Versions

default

Flavors

Struct embassy_net::tcp::TcpReader

source ·
pub struct TcpReader<'a> { /* private fields */ }
Expand description

The reader half of a TCP socket.

Implementations§

source§

impl<'a> TcpReader<'a>

source

pub async fn read(&mut self, buf: &mut [u8]) -> Result<usize, Error>

Read data from the socket.

Returns how many bytes were read, or an error. If no data is available, it waits until there is at least one byte available.

source

pub async fn read_with<F, R>(&mut self, f: F) -> Result<R, Error>
where F: FnOnce(&mut [u8]) -> (usize, R),

Call f with the largest contiguous slice of octets in the receive buffer, and dequeue the amount of elements returned by f.

If no data is available, it waits until there is at least one byte available.

source

pub fn recv_capacity(&self) -> usize

Return the maximum number of bytes inside the transmit buffer.

Trait Implementations§

source§

impl<'d> ErrorType for TcpReader<'d>

§

type Error = Error

Error type of all the IO operations on this type.
source§

impl<'d> Read for TcpReader<'d>

source§

async fn read(&mut self, buf: &mut [u8]) -> Result<usize, Self::Error>

Read some bytes from this source into the specified buffer, returning how many bytes were read. Read more
source§

async fn read_exact( &mut self, buf: &mut [u8] ) -> Result<(), ReadExactError<Self::Error>>

Read the exact number of bytes required to fill buf. Read more
source§

impl<'d> ReadReady for TcpReader<'d>

source§

fn read_ready(&mut self) -> Result<bool, Self::Error>

Get whether the reader is ready for immediately reading. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for TcpReader<'a>

§

impl<'a> !RefUnwindSafe for TcpReader<'a>

§

impl<'a> !Send for TcpReader<'a>

§

impl<'a> !Sync for TcpReader<'a>

§

impl<'a> Unpin for TcpReader<'a>

§

impl<'a> !UnwindSafe for TcpReader<'a>

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

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, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.