Struct smoltcp::phy::TunTapInterface

pub struct TunTapInterface { /* private fields */ }

A virtual TUN (IP) or TAP (Ethernet) interface.

Implementations

impl TunTapInterface

pub fn new(name: &str, medium: Medium) -> Result<TunTapInterface>

Attaches to a TUN/TAP interface called name, or creates it if it does not exist.

If name is a persistent interface configured with UID of the current user, no special privileges are needed. Otherwise, this requires superuser privileges or a corresponding capability set on the executable.

pub fn from_fd(fd: RawFd, medium: Medium, mtu: usize) -> Result<TunTapInterface>

Attaches to a TUN/TAP interface specified by file descriptor fd.

On platforms like Android, a file descriptor to a tun interface is exposed. On these platforms, a TunTapInterface cannot be instantiated with a name.

Trait Implementations

impl AsRawFd for TunTapInterface

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Debug for TunTapInterface

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

Formats the value using the given formatter.

impl Device for TunTapInterface

type RxToken<'a> = RxToken

type TxToken<'a> = TxToken

fn capabilities(&self) -> DeviceCapabilities

Get a description of device capabilities.

fn receive( &mut self, _timestamp: Instant ) -> Option<(Self::RxToken<'_>, Self::TxToken<'_>)>

Construct a token pair consisting of one receive token and one transmit token.

fn transmit(&mut self, _timestamp: Instant) -> Option<Self::TxToken<'_>>

Construct a transmit token.