Struct async_tun::TunBuilder

pub struct TunBuilder<'a> { /* fields omitted */ }

Represents a factory to build new instances of Tun.

Implementations

impl<'a> TunBuilder<'a>

pub fn new() -> Self

Creates a new instance of TunBuilder.

pub fn name(self, name: &'a str) -> Self

Sets the name of device (max length: 16 characters), if it is empty, then device name is set by kernel. Default value is empty.

pub fn tap(self, is_tap: bool) -> Self

If is_tap is true, a TAP device is allocated, otherwise, a TUN device is created. Default value is false.

pub fn packet_info(self, packet_info: bool) -> Self

If packet_info is false, then IFF_NO_PI flag is set. Default value is true.

pub fn mtu(self, mtu: i32) -> Self

Sets the MTU of device.

pub fn owner(self, owner: i32) -> Self

Sets the owner of device.

pub fn group(self, group: i32) -> Self

Sets the group of device.

pub fn address(self, address: Ipv4Addr) -> Self

Sets IPv4 address of device.

pub fn destination(self, dst: Ipv4Addr) -> Self

Sets IPv4 destination address of device.

pub fn broadcast(self, broadcast: Ipv4Addr) -> Self

Sets IPv4 broadcast address of device.

pub fn netmask(self, netmask: Ipv4Addr) -> Self

Sets IPv4 netmask address of device.

pub fn mac(self, mac: MacAddress) -> Self

Sets Ethernet MAC address of device (for tap mode).

pub fn persist(self) -> Self

Makes the device persistent.

pub fn up(self) -> Self

Sets up the device.

pub async fn try_build(self) -> Result<Tun>

Builds a new instance of Tun.

pub async fn try_build_mq(self, queues: usize) -> Result<Vec<Tun>>

Builds multiple instances of Tun with IFF_MULTI_QUEUE flag.

Trait Implementations

impl<'a> Default for TunBuilder<'a>

fn default() -> Self

Returns the “default value” for a type.