Struct w5500_hl::TcpWriter

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

Streaming writer for a TCP socket buffer.

This implements the Seek traits.

Created with Tcp::tcp_writer.

Example

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

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 mut writer: TcpWriter<_> = w5500.tcp_writer(MQTT_SOCKET)?;
writer.write_all(&CONNECT)?;
writer.send()?;

Trait Implementations

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

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

Formats the value using the given formatter.

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

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

Writes the defmt representation of self to fmt.

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

fn eq(&self, other: &TcpWriter<'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 TcpWriter<'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 TcpWriter<'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 TcpWriter<'w, W5500>

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

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