Struct Configuration

pub struct Configuration { /* private fields */ }

Configuration builder for a TUN interface.

Implementations

impl Configuration

pub fn platform_config<F>(&mut self, f: F) -> &mut Self

where F: FnOnce(&mut PlatformConfig),

Access the platform-dependent configuration.

pub fn name<S: AsRef<str>>(&mut self, tun_name: S) -> &mut Self

👎Deprecated since 1.1.2: Since the API name may have an easy name conflict when IDE prompts, it is replaced by tun_name for better coding experience

Functionally equivalent to tun_name

pub fn tun_name<S: AsRef<str>>(&mut self, tun_name: S) -> &mut Self

Set the tun name.

[Note: on macOS, the tun name must be the form utunx where x is a number, such as utun3. – end note]

pub fn address<A: IntoAddress>(&mut self, value: A) -> &mut Self

Set the address.

pub fn destination<A: IntoAddress>(&mut self, value: A) -> &mut Self

Set the destination address.

pub fn broadcast<A: IntoAddress>(&mut self, value: A) -> &mut Self

Set the broadcast address.

pub fn netmask<A: IntoAddress>(&mut self, value: A) -> &mut Self

Set the netmask.

pub fn mtu(&mut self, value: u16) -> &mut Self

Set the MTU.

[Note: mtu on the Windows platform is always 65535 due to wintun – end note]

pub fn up(&mut self) -> &mut Self

Set the interface to be enabled once created.

pub fn down(&mut self) -> &mut Self

Set the interface to be disabled once created.

pub fn layer(&mut self, value: Layer) -> &mut Self

Set the OSI layer of operation.

pub fn queues(&mut self, value: usize) -> &mut Self

👎Deprecated since 1.0.0: The queues will always be 1.

Set the number of queues. Note: The queues must be 1, otherwise will failed.

pub fn raw_fd(&mut self, fd: RawFd) -> &mut Self

Set the raw fd.

pub fn close_fd_on_drop(&mut self, value: bool) -> &mut Self

Set whether to close the received raw file descriptor on drop or not. The default behaviour is to close the received or tun2 generated file descriptor. Note: If this is set to false, it is up to the caller to ensure the file descriptor that they pass via Configuration::raw_fd is properly closed.

Trait Implementations

impl Clone for Configuration

fn clone(&self) -> Configuration

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Configuration

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

Formats the value using the given formatter.

impl Default for Configuration

fn default() -> Configuration

Returns the “default value” for a type.