Struct w5500_hl::TcpReader

pub struct TcpReader<'w, W5500> { /* private fields */ }

Streaming reader for a TCP socket buffer.

This implements the Read and Seek traits.

Created with Tcp::tcp_reader.

Example

use w5500_hl::{
    io::Read,
    ll::{Registers, Sn, SocketInterrupt},
    net::{Ipv4Addr, SocketAddrV4},
    Tcp, TcpReader,
};

const MQTT_SOCKET: Sn = Sn::Sn0;
const MQTT_SOURCE_PORT: u16 = 33650;
const MQTT_SERVER: SocketAddrV4 = SocketAddrV4::new(Ipv4Addr::new(192, 168, 2, 10), 1883);

w5500.tcp_connect(MQTT_SOCKET, MQTT_SOURCE_PORT, &MQTT_SERVER)?;

// ... wait for a CON interrupt

const CONNECT: [u8; 14] = [
    0x10, 0x0C, 0x00, 0x04, b'M', b'Q', b'T', b'T', 0x04, 0x02, 0x0E, 0x10, 0x00, 0x00,
];
let tx_bytes: u16 = w5500.tcp_write(MQTT_SOCKET, &CONNECT)?;
assert_eq!(usize::from(tx_bytes), CONNECT.len());

// ... wait for a RECV interrupt

let mut reader: TcpReader<_> = w5500.tcp_reader(MQTT_SOCKET)?;
let mut buf = [0; 2];

// read the first two bytes
reader.read_exact(&mut buf)?;
// ... do something with the data

// read another two bytes into the same buffer
reader.read_exact(&mut buf)?;
// ... do something with the data

// mark the data as read
reader.done()?;

Trait Implementations

impl<'w, W5500: Debug> Debug for TcpReader<'w, W5500>

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

Formats the value using the given formatter.

impl<'w, W5500> Format for TcpReader<'w, W5500>where W5500: Format,

fn format(&self, f: Formatter<'_>)

Writes the defmt representation of self to fmt.

impl<'a, W5500: Registers> Read<<W5500 as Registers>::Error> for TcpReader<'a, W5500>

fn read(&mut self, buf: &mut [u8]) -> Result<u16, W5500::Error>

Read data from the UDP socket, and return the number of bytes read.

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

Read the exact number of bytes required to fill buf.

fn done(self) -> Result<(), W5500::Error>

Mark the data as read, removing the data from the queue.

impl<'w, W5500> Seek for TcpReader<'w, W5500>

fn seek<E>(&mut self, pos: SeekFrom) -> Result<(), Error<E>>

Seek to an offset, in bytes, within the socket buffer.

fn rewind(&mut self)

Rewind to the beginning of the stream.

fn stream_len(&self) -> u16

Return the length of the stream, in bytes.

fn stream_position(&self) -> u16

Returns the current seek position from the start of the stream.

fn remain(&self) -> u16

Remaining bytes in the socket buffer from the current seek position.