Struct Device

pub struct Device { /* private fields */ }

Represents a blocking TUN/TAP device.

Contains the shared code between Tun and Tap.

Implementations

impl 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 AsRawFd for Device

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Debug for Device

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

Formats the value using the given formatter.

impl Read for Device

fn read(&mut self, buf: &mut [u8]) -> Result<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 Device

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

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

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

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, fmt: 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.