Struct Tap

pub struct Tap {
    pub tap_file: File,
    /* private fields */
}

Handle for a network tap interface.

For now, this simply wraps the file descriptor for the tap device so methods can run ioctls on the interface. The tap interface fd will be closed when Tap goes out of scope, and the kernel will clean up the interface automatically.

Fields

tap_file: File

tap device file handle

Implementations

impl Tap

pub fn new() -> Result<Tap, Error>

Create a new tap interface.

pub fn set_ip_addr(&self, ip_addr: Ipv4Addr) -> Result<(), Error>

Set the host-side IP address for the tap interface.

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

Set the netmask for the subnet that the tap interface will exist on.

impl Tap

pub fn open_named(if_name: &str, multi_vq: bool) -> Result<Tap, Error>

Create a TUN/TAP device given the interface name.

Arguments

• if_name - the name of the interface.

Example

use dbs_utils::net::Tap;
Tap::open_named("doc-test-tap", false).unwrap();

pub fn into_mq_taps(self, vq_pairs: usize) -> Result<Vec<Tap>, Error>

Change the origin tap into multiqueue taps.

pub fn set_offload(&self, flags: c_uint) -> Result<(), Error>

Set the offload flags for the tap interface.

pub fn enable(&self) -> Result<(), Error>

Enable the tap interface.

pub fn set_vnet_hdr_size(&self, size: c_int) -> Result<(), Error>

Set the size of the vnet hdr.

pub fn if_flags(&self) -> u32

Get the origin flags when interface was created.

Trait Implementations

impl AsRawFd for Tap

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Debug for Tap

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

Formats the value using the given formatter.

impl PartialEq for Tap

fn eq(&self, other: &Tap) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Read for Tap

fn read(&mut self, buf: &mut [u8]) -> IoResult<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Reads the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.

impl Write for Tap

fn write(&mut self, buf: &[u8]) -> IoResult<usize>

Writes a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> IoResult<()>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.