Struct AsyncTun

pub struct AsyncTun(/* private fields */);

Available on crate feature tokio only.

Represents a non-blocking TUN device.

Implementations

impl AsyncTun

pub fn new(name: impl AsRef<str>, packet_info: bool) -> Result<Self>

Methods from Deref<Target = AsyncDevice>

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

Tries to read data from the device and fill the buffer buf.

Arguments

• buf: Buffer to be filled with the data read from the device.

Returns

• Ok: Containing the number of bytes read from the device.
• Err: If the device was not ready to be read(a WOULDBLOCK err), or some other error occurred.

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

Tries to write data from the buf to the device.

Arguments

• buf: Data to be written to the device.

Returns

• Ok: Containing the number of bytes written to the device.
• Err: If the device was not ready to be written to(a WOULDBLOCK err), or some other error occurred.

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

Asyncronously reads data from the device and writes to the buf.

Arguments

• buf: Buffer to be filled with the data read from the device.

Returns

• Ok: Containing the number of bytes read from the device.
• Err: If reading data was unsuccessful.

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

Asyncronously writes data from buf to the device.

Arguments

• buf: Buffer to be written to the device.

Returns

• Ok: Containing the number of bytes written from the device.
• Err: If writting data was unsuccessful.

Methods from Deref<Target = Device>

pub fn name(&self) -> String

Returns The name of the device chosen by the kernel.

pub fn flags(&self) -> Result<Flags>

Returns the active flags of the interface.

pub fn bring_up(&self) -> Result<()>

Brings the device up which makes it ready to send and receive packets.

pub fn bring_down(&self) -> Result<()>

Brings the device down which makes it unable to send and receive packets.

pub fn set_mtu(&self, mtu: i32) -> Result<()>

Sets the MTU of the device.

pub fn get_mtu(&self) -> Result<i32>

Returns the MTU of the device.

pub fn set_netmask(&self, netmask: Ipv4Addr) -> Result<()>

Sets the netmask of the device.

pub fn get_netmask(&self) -> Result<Ipv4Addr>

Sets the netmask of the device.

pub fn get_index(&self) -> Result<i32>

Returns the index of the interface.

pub fn set_ipv6_addr(&self, addr: Ipv6Addr) -> Result<()>

Adds the specified addr to the list of IPv6 addresses of the interface.

pub fn get_ipv6_addrs(&self) -> Result<Vec<Ipv6Addr>>

Returns the list of IPv6 addresses of the interface.

pub fn del_ipv6_addr(&self, addr: Ipv6Addr) -> Result<()>

Deletes the specified IPv6 address from the interface.

pub fn set_addr(&self, addr: Ipv4Addr) -> Result<()>

Sets the IPv4 address of the device.

pub fn get_addr(&self) -> Result<Ipv4Addr>

Returns the IPv4 address of the device.

pub fn del_addr(&self) -> Result<()>

Deletes the IPv4 address of the interface.

pub fn set_brd_addr(&self, addr: Ipv4Addr) -> Result<()>

Sets the broadcast IPv4 address of the device.

pub fn get_brd_addr(&self) -> Result<Ipv4Addr>

Returns the broadcast IPv4 address of the device.

pub fn set_dst_addr(&self, addr: Ipv4Addr) -> Result<()>

Sets the destination IPv4 address of the device.

pub fn get_dst_addr(&self) -> Result<Ipv4Addr>

Returns the destination IPv4 address of the device.

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

Writes the data in buf into the device.

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

Reads the data from device into buf.

Trait Implementations

impl Debug for AsyncTun

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

Formats the value using the given formatter.

impl Deref for AsyncTun

type Target = AsyncDevice

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for AsyncTun

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.