Struct EspAsyncTls 

pub struct EspAsyncTls<S>(/* private fields */)
where
    S: PollableSocket;

Implementations

impl<S> EspAsyncTls<S>

where S: PollableSocket,

pub fn adopt(socket: S) -> Result<Self, EspError>

Create a new AsyncEspTls instance adopting the supplied socket. The socket should be in a connected state.

Errors

• ESP_ERR_NO_MEM if not enough memory to create the TLS connection

pub async fn negotiate( &mut self, hostname: &str, cfg: &Config<'_>, ) -> Result<CompletedHandshake, EspError>

Establish a TLS/SSL connection using the adopted socket.

Errors

• ESP_ERR_INVALID_SIZE if cfg.alpn_protos exceeds 9 elements or avg 10 bytes/ALPN
• ESP_FAIL if connection could not be established

pub async fn negotiate_server( &mut self, cfg: &ServerConfig<'_>, ) -> Result<(), EspError>

Establish a TLS/SSL connection using the adopted socket, acting as the server.

Requires ESP-IDF >= 5.5.0 with mbedTLS.

Note that the handshake is not bounded in time (cfg.tls_handshake_timeout_ms is only honored by the blocking EspTls::negotiate_server), so a misbehaving peer can keep the negotiation going indefinitely. Callers which cannot afford that should race this future against a timer.

Errors

• ESP_FAIL if the connection could not be established

pub async fn read(&self, buf: &mut [u8]) -> Result<usize, EspError>

Read in the supplied buffer. Returns the number of bytes read.

pub fn poll_read( &self, ctx: &mut Context<'_>, buf: &mut [u8], ) -> Poll<Result<usize, EspError>>

pub async fn write(&self, buf: &[u8]) -> Result<usize, EspError>

Write the supplied buffer. Returns the number of bytes written.

pub fn poll_write( &self, ctx: &mut Context<'_>, buf: &[u8], ) -> Poll<Result<usize, EspError>>

pub async fn write_all(&self, buf: &[u8]) -> Result<(), EspError>

pub fn context_handle(&self) -> *mut esp_tls

Trait Implementations

impl<S> AsyncRead for EspAsyncTls<S>

where S: PollableSocket,

Available on crate feature std and non-esp_idf_version_major=4 and (non-esp_idf_version_major=5 or non-esp_idf_version_minor=0) only.

fn poll_read( self: Pin<&mut Self>, ctx: &mut Context<'_>, buf: &mut [u8], ) -> Poll<Result<usize>>

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &mut [IoSliceMut<'_>], ) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl<S> AsyncRead for &EspAsyncTls<S>

where S: PollableSocket,

Available on crate feature std and non-esp_idf_version_major=4 and (non-esp_idf_version_major=5 or non-esp_idf_version_minor=0) only.

fn poll_read( self: Pin<&mut Self>, ctx: &mut Context<'_>, buf: &mut [u8], ) -> Poll<Result<usize>>

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &mut [IoSliceMut<'_>], ) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl<S> AsyncWrite for EspAsyncTls<S>

where S: PollableSocket,

Available on crate feature std and non-esp_idf_version_major=4 and (non-esp_idf_version_major=5 or non-esp_idf_version_minor=0) only.

fn poll_write( self: Pin<&mut Self>, ctx: &mut Context<'_>, buf: &[u8], ) -> Poll<Result<usize>>

Attempt to write bytes from buf into the object.

fn poll_flush(self: Pin<&mut Self>, _ctx: &mut Context<'_>) -> Poll<Result<()>>

Attempt to flush the object, ensuring that any buffered data reach their destination.

fn poll_close(self: Pin<&mut Self>, _ctx: &mut Context<'_>) -> Poll<Result<()>>

Attempt to close the object.

fn poll_write_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &[IoSlice<'_>], ) -> Poll<Result<usize, Error>>

Attempt to write bytes from bufs into the object using vectored IO operations.

impl<S> AsyncWrite for &EspAsyncTls<S>

where S: PollableSocket,

Available on crate feature std and non-esp_idf_version_major=4 and (non-esp_idf_version_major=5 or non-esp_idf_version_minor=0) only.

fn poll_write( self: Pin<&mut Self>, ctx: &mut Context<'_>, buf: &[u8], ) -> Poll<Result<usize>>

Attempt to write bytes from buf into the object.

fn poll_flush(self: Pin<&mut Self>, _ctx: &mut Context<'_>) -> Poll<Result<()>>

Attempt to flush the object, ensuring that any buffered data reach their destination.

fn poll_close(self: Pin<&mut Self>, _ctx: &mut Context<'_>) -> Poll<Result<()>>

Attempt to close the object.

fn poll_write_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &[IoSlice<'_>], ) -> Poll<Result<usize, Error>>

Attempt to write bytes from bufs into the object using vectored IO operations.

impl<S> ErrorType for EspAsyncTls<S>

where S: PollableSocket,

Available on non-esp_idf_version_major=4 and (non-esp_idf_version_major=5 or non-esp_idf_version_minor=0) only.

type Error = EspIOError

Error type of all the IO operations on this type.

impl<S> Read for EspAsyncTls<S>

where S: PollableSocket,

Available on non-esp_idf_version_major=4 and (non-esp_idf_version_major=5 or non-esp_idf_version_minor=0) only.

async fn read(&mut self, buf: &mut [u8]) -> Result<usize, Self::Error>

Read some bytes from this source into the specified buffer, returning how many bytes were read.

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

Read the exact number of bytes required to fill buf.

impl<S> Write for EspAsyncTls<S>

where S: PollableSocket,

Available on non-esp_idf_version_major=4 and (non-esp_idf_version_major=5 or non-esp_idf_version_minor=0) only.

async fn write(&mut self, buf: &[u8]) -> Result<usize, Self::Error>

Write a buffer into this writer, returning how many bytes were written.

async fn flush(&mut self) -> Result<(), Self::Error>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

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

Write an entire buffer into this writer.