Struct w5500_hl::UdpWriter

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

Streaming writer for a UDP socket buffer.

This implements the Seek traits.

Created with Udp::udp_writer.

Example

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

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

w5500.udp_bind(Sn0, 8080)?;

let mut udp_writer: UdpWriter<_> = w5500.udp_writer(Sn0)?;

let data_header: [u8; 10] = [0; 10];
let n_written: u16 = udp_writer.write(&data_header)?;
assert_eq!(usize::from(n_written), data_header.len());

let data: [u8; 123] = [0; 123];
let n_written: u16 = udp_writer.write(&data)?;
assert_eq!(usize::from(n_written), data.len());

udp_writer.udp_send_to(&DEST)?;

Implementations

impl<'w, W5500: Registers> UdpWriter<'w, W5500>

pub fn udp_send_to(self, addr: &SocketAddrV4) -> Result<(), W5500::Error>

Send all data previously written with UdpWriter::write and UdpWriter::write_all to the given address.

Panics

• (debug) The socket must be opened as a UDP socket.

Trait Implementations

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

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

Formats the value using the given formatter.

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

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

Writes the defmt representation of self to fmt.

impl<'w, W5500: PartialEq> PartialEq for UdpWriter<'w, W5500>

fn eq(&self, other: &UdpWriter<'w, W5500>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'w, W5500> Seek for UdpWriter<'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.

impl<'w, W5500: Registers> Write<<W5500 as Registers>::Error> for UdpWriter<'w, W5500>

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

Write data to the socket buffer, and return the number of bytes written.

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

Writes all the data, returning Error::OutOfMemory if the size of buf exceeds the free memory available in the socket buffer.

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

Send all data previously written with write and write_all.

impl<'w, W5500: Eq> Eq for UdpWriter<'w, W5500>

impl<'w, W5500> StructuralEq for UdpWriter<'w, W5500>

impl<'w, W5500> StructuralPartialEq for UdpWriter<'w, W5500>