Struct TunTapDriver 

pub struct TunTapDriver { /* private fields */ }

A driver for a virtual TUN (IP) or TAP (Ethernet) interface.

Implementations

impl TunTapDriver

pub fn new(name: &str, hardware_addr: HardwareAddress) -> Result<TunTapDriver>

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

hardware_addr is the address the interface reports to the stack, and picks the medium: HardwareAddress::Ip opens a TUN interface, an Ethernet address opens a TAP one.

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, hardware_addr: HardwareAddress, mtu: usize, ) -> Result<TunTapDriver>

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 TunTapDriver cannot be instantiated with a name.

hardware_addr is the address the interface reports to the stack, and picks the medium, as in new.

Trait Implementations

impl AsRawFd for TunTapDriver

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Debug for TunTapDriver

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

Formats the value using the given formatter.

impl Driver for TunTapDriver

fn capabilities(&self) -> Capabilities

Get a description of the device’s capabilities.

fn hardware_address(&self) -> HardwareAddress

Get the device’s hardware address.

fn receive(&mut self) -> Option<PacketBuf>

Poll for a received frame.

fn transmit(&mut self, buf: PacketBuf) -> Result<(), PacketBuf>

Queue a frame for transmission, transferring ownership of the buffer to the driver.

fn can_transmit(&mut self) -> bool

Whether the device can transmit one frame right now.

fn link_state(&mut self) -> LinkState

Get the link state.

fn poll_tx_timestamp(&mut self) -> Option<TxTimestamp>

Poll for the timestamp of an already-transmitted packet.

impl Drop for TunTapDriver

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.