Struct w5500_hl::UdpReader

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

Streaming reader for a UDP socket buffer.

This implements the Read and Seek traits.

Created with Udp::udp_reader.

Example

use w5500_hl::{
    io::Read,
    ll::{Registers, Sn::Sn0},
    net::{Ipv4Addr, SocketAddrV4},
    Udp, UdpReader,
};

const DEST: SocketAddrV4 = SocketAddrV4::new(Ipv4Addr::new(192, 0, 2, 1), 8081);

w5500.udp_bind(Sn0, 8080)?;

let mut reader: UdpReader<_> = w5500.udp_reader(Sn0)?;

let mut buf: [u8; 8] = [0; 8];
reader.read_exact(&mut buf)?;

let mut other_buf: [u8; 16] = [0; 16];
reader.read_exact(&mut buf)?;

// mark the datagram as done, removing it from the queue
reader.done()?;

Implementations

impl<'a, W: Registers> UdpReader<'a, W>

pub fn header(&self) -> &UdpHeader

Get the UDP header.

Example

use w5500_hl::{
    ll::{Registers, Sn::Sn0},
    net::{Ipv4Addr, SocketAddrV4},
    Udp, UdpHeader, UdpReader,
};

const DEST: SocketAddrV4 = SocketAddrV4::new(Ipv4Addr::new(192, 0, 2, 1), 8081);

w5500.udp_bind(Sn0, 8080)?;

let reader: UdpReader<_> = w5500.udp_reader(Sn0)?;
let header: &UdpHeader = reader.header();

Trait Implementations

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

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

Formats the value using the given formatter.

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

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

Writes the defmt representation of self to fmt.

impl<'w, W5500: Registers> Read<<W5500 as Registers>::Error> for UdpReader<'w, 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 UdpReader<'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.