Struct async_tun::Tun

pub struct Tun { /* fields omitted */ }

Represents a Tun/Tap device. Use TunBuilder to create a new instance of Tun.

Implementations

impl Tun

pub fn name(&self) -> &str

Returns the name of Tun/Tap device.

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

Returns the value of MTU.

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

Returns the IPv4 address of MTU.

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

Returns the IPv4 destination address of MTU.

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

Returns the IPv4 broadcast address of MTU.

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

Returns the IPv4 netmask address of MTU.

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

Returns the flags of MTU.

Methods from Deref<Target = File>

pub async fn sync_all(&'_ self) -> Result<(), Error>

Synchronizes OS-internal buffered contents and metadata to disk.

This function will ensure that all in-memory data reaches the filesystem.

This can be used to handle errors that would otherwise only be caught when the file is closed. When a file is dropped, errors in synchronizing this in-memory data are ignored.

Examples

use async_std::fs::File;
use async_std::prelude::*;

let mut file = File::create("a.txt").await?;
file.write_all(b"Hello, world!").await?;
file.sync_all().await?;

pub async fn sync_data(&'_ self) -> Result<(), Error>

Synchronizes OS-internal buffered contents to disk.

This is similar to sync_all, except that file metadata may not be synchronized.

This is intended for use cases that must synchronize the contents of the file, but don't need the file metadata synchronized to disk.

Note that some platforms may simply implement this in terms of sync_all.

Examples

use async_std::fs::File;
use async_std::prelude::*;

let mut file = File::create("a.txt").await?;
file.write_all(b"Hello, world!").await?;
file.sync_data().await?;

pub async fn set_len(&'_ self, size: u64) -> Result<(), Error>

Truncates or extends the file.

If size is less than the current file size, then the file will be truncated. If it is greater than the current file size, then the file will be extended to size and have all intermediate data filled with zeros.

The file's cursor stays at the same position, even if the cursor ends up being past the end of the file after this operation.

Examples

use async_std::fs::File;

let file = File::create("a.txt").await?;
file.set_len(10).await?;

pub async fn metadata(&'_ self) -> Result<Metadata, Error>

Reads the file's metadata.

Examples

use async_std::fs::File;

let file = File::open("a.txt").await?;
let metadata = file.metadata().await?;

pub async fn set_permissions(&'_ self, perm: Permissions) -> Result<(), Error>

Changes the permissions on the file.

Errors

An error will be returned in the following situations:

• The current process lacks permissions to change attributes on the file.
• Some other I/O error occurred.

Examples

use async_std::fs::File;

let file = File::create("a.txt").await?;

let mut perms = file.metadata().await?.permissions();
perms.set_readonly(true);
file.set_permissions(perms).await?;

Trait Implementations

impl Clone for Tun

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Deref for Tun

type Target = File

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for Tun

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

Mutably dereferences the value.