Struct EspEth

pub struct EspEth<'d, T> { /* private fields */ }

EspEth wraps an EthDriver Data Link layer instance, and binds the OSI Layer 3 (network) facilities of ESP IDF to it.

In other words, it connects the ESP IDF ethernet Netif interface to the ethernet driver. This allows users to utilize the Rust STD APIs for working with TCP and UDP sockets.

This struct should be the default option for an ethernet driver in all use cases but the niche one where bypassing the ESP IDF Netif and lwIP stacks is desirable. E.g., using smoltcp or other custom IP stacks on top of the ESP IDF ethernet peripheral.

Implementations

impl<'d, T> EspEth<'d, T>

pub fn wrap(driver: EthDriver<'d, T>) -> Result<Self, EspError>

pub fn wrap_all( driver: EthDriver<'d, T>, netif: EspNetif, ) -> Result<Self, EspError>

pub fn swap_netif(&mut self, netif: EspNetif) -> Result<EspNetif, EspError>

pub fn driver(&self) -> &EthDriver<'d, T>

pub fn driver_mut(&mut self) -> &mut EthDriver<'d, T>

pub fn netif(&self) -> &EspNetif

pub fn netif_mut(&mut self) -> &mut EspNetif

pub fn start(&mut self) -> Result<(), EspError>

pub fn stop(&mut self) -> Result<(), EspError>

pub fn is_started(&self) -> Result<bool, EspError>

pub fn is_connected(&self) -> Result<bool, EspError>

pub fn is_up(&self) -> Result<bool, EspError>

Trait Implementations

impl<T> Drop for EspEth<'_, T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T> Eth for EspEth<'_, T>

type Error = EspError

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

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

fn is_started(&self) -> Result<bool, Self::Error>

fn is_connected(&self) -> Result<bool, Self::Error>

impl<T> NetifStatus for EspEth<'_, T>

fn is_up(&self) -> Result<bool, EspError>

impl<T> NetifStatus for EspEth<'_, T>

async fn is_up(&self) -> Result<bool, EspError>

impl<T> RawHandle for EspEth<'_, T>

type Handle = *mut esp_eth_netif_glue_t

fn handle(&self) -> Self::Handle

Care should be taken to use the returned ESP-IDF driver raw handle only while the driver is still alive, so as to avoid use-after-free errors.

impl<T> Send for EspEth<'_, T>