Struct Device

pub struct Device { /* private fields */ }

A TUN device using the TUN/TAP Linux driver.

Implementations

impl Device

pub fn new(config: &Configuration) -> Result<Self>

Create a new Device for the given Configuration.

pub fn persist(&mut self) -> Result<()>

Make the device persistent.

pub fn user(&mut self, value: i32) -> Result<()>

Set the owner of the device.

pub fn group(&mut self, value: i32) -> Result<()>

Set the group of the device.

pub fn split(self) -> (Reader, Writer)

Split the interface into a Reader and Writer.

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

Recv a packet from tun device

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

Send a packet to tun device

Trait Implementations

impl AbstractDevice for Device

fn tun_index(&self) -> Result<i32>

Get the device index.

fn tun_name(&self) -> Result<String>

Get the device tun name.

fn set_tun_name(&mut self, value: &str) -> Result<()>

Set the device tun name.

fn enabled(&mut self, value: bool) -> Result<()>

Turn on or off the interface.

fn address(&self) -> Result<IpAddr>

Get the address.

fn set_address(&mut self, value: IpAddr) -> Result<()>

Set the address.

fn destination(&self) -> Result<IpAddr>

Get the destination address.

fn set_destination(&mut self, value: IpAddr) -> Result<()>

Set the destination address.

fn broadcast(&self) -> Result<IpAddr>

Get the broadcast address.

fn set_broadcast(&mut self, value: IpAddr) -> Result<()>

Set the broadcast address.

fn netmask(&self) -> Result<IpAddr>

Get the netmask.

fn set_netmask(&mut self, value: IpAddr) -> Result<()>

Set the netmask.

fn mtu(&self) -> Result<u16>

Get the MTU.

fn set_mtu(&mut self, value: u16) -> Result<()>

Set the MTU.

fn packet_information(&self) -> bool

Return whether the underlying tun device on the platform has packet information

fn configure(&mut self, config: &Configuration) -> Result<()>

Reconfigure the device.

impl AsMut<dyn AbstractDevice> for Device

fn as_mut(&mut self) -> &mut (dyn AbstractDevice + 'static)

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRawFd for Device

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl AsRef<dyn AbstractDevice> for Device

fn as_ref(&self) -> &(dyn AbstractDevice + 'static)

Converts this type into a shared reference of the (usually inferred) input type.

impl IntoRawFd for Device

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.

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>

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>

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.