Struct w5500_tls::TlsReader

pub struct TlsReader<'buf, 'ptr> { /* private fields */ }

Reader for a TLS application data record.

This implements the w5500-hl IO traits, Read and Seek.

Created by Client::reader.

Example

use w5500_tls::{
    Client, Event, TlsReader,
    {
        hl::{io::Read, Hostname},
        ll::{
            net::{Ipv4Addr, SocketAddrV4},
            Sn,
        },
    },
};

static mut RX: [u8; 2048] = [0; 2048];

const DST: SocketAddrV4 = SocketAddrV4::new(Ipv4Addr::new(192, 168, 0, 4), 8883);
const HOSTNAME: Hostname = Hostname::new_unwrapped("server.local");
const SRC_PORT: u16 = 1234;
const TLS_SN: Sn = Sn::Sn4;

let mut tls_client: Client<2048> = Client::new(
    TLS_SN,
    SRC_PORT,
    HOSTNAME,
    DST,
    b"mykeyidentity",
    &MY_KEY,
    unsafe { &mut RX },
);

// wait until there is application data
// for demonstration purposes only, please do not actually do this
while tls_client.process(&mut w5500, &mut rng, monotonic_secs()) != Ok(Event::ApplicationData) {
}

let mut reader: TlsReader = tls_client.reader()?;
let mut buf: [u8; 5] = [0; 5];
reader.read_exact(&mut buf)?;
reader.done()?;

Trait Implementations

impl<'buf, 'ptr> Debug for TlsReader<'buf, 'ptr>

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

Formats the value using the given formatter.

impl<'buf, 'ptr> Format for TlsReader<'buf, 'ptr>

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

Writes the defmt representation of self to fmt.

impl<'buf, 'ptr> PartialEq for TlsReader<'buf, 'ptr>

fn eq(&self, other: &TlsReader<'buf, 'ptr>) -> 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<'buf, 'ptr> Read<Infallible> for TlsReader<'buf, 'ptr>

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

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

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

Read the exact number of bytes required to fill buf.

fn done(self) -> Result<(), Infallible>

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

impl<'buf, 'ptr> Seek for TlsReader<'buf, 'ptr>

fn seek<Infallible>(&mut self, pos: SeekFrom) -> Result<(), HlError<Infallible>>

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<'buf, 'ptr> Eq for TlsReader<'buf, 'ptr>

impl<'buf, 'ptr> StructuralEq for TlsReader<'buf, 'ptr>

impl<'buf, 'ptr> StructuralPartialEq for TlsReader<'buf, 'ptr>