Struct Tap

pub struct Tap { /* private fields */ }

Available on non-Windows only.

A cross-platform TAP interface, suitable for tunnelling link-layer packets.

Implementations

impl Tap

pub fn new() -> Result<Self>

Creates a new, unique TUN device.

pub fn new_named(if_name: Interface) -> Result<Self>

Opens or creates a TUN device of the given name.

pub fn name(&self) -> Result<Interface>

Retrieves the interface name of the TUN device.

pub fn set_state(&mut self, state: DeviceState) -> Result<()>

Sets the adapter state of the TAP device (e.g. “up” or “down”).

pub fn set_up(&mut self) -> Result<()>

Sets the adapter state of the TAP device to “up”.

pub fn set_down(&mut self) -> Result<()>

Sets the adapter state of the TAP device to “down”.

pub fn mtu(&self) -> Result<usize>

Retrieves the Maximum Transmission Unit (MTU) of the TAP device.

pub fn set_nonblocking(&mut self, nonblocking: bool) -> Result<()>

Sets the blocking mode of the TAP device for reads/writes.

pub fn nonblocking(&self) -> Result<bool>

Retrieves the blocking mode of the TAP device.

pub fn addrs(&self) -> Result<Vec<AddressInfo>>

Retrieves the network-layer addresses assigned to the interface.

Most platforms automatically assign a link-local IPv6 address to TAP devices on creation. Developers should take this into account and avoid the incorrect assumption that addrs() will return only the addresses they have assigned via add_addr().

pub fn add_addr<A: Into<AddAddress>>(&self, req: A) -> Result<()>

Assigns a network-layer address to the interface.

pub fn remove_addr(&self, addr: IpAddr) -> Result<()>

Removes the specified network-layer address from the interface.

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

Sends a packet out over the TAP device.

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

Receives a packet over the TAP device.

Trait Implementations

impl AsFd for Tap

fn as_fd(&self) -> BorrowedFd<'_>

Borrows the file descriptor.

impl AsRawFd for Tap

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.