Struct tap_windows::Device

pub struct Device { /* fields omitted */ }

A tap-windows device handle, it offers facilities to:

• create, open and delete interfaces
• write and read the current configuration
• write and read packets from the device Example

use tap_windows::Device;
use std::io::Read;

const MY_INTERFACE: &str = "My Interface";

// Try to open the device
let mut dev = Device::open(MY_INTERFACE)
    .or_else(|_| -> std::io::Result<_> {
        // The device does not exists...
        // try creating a new one
         
        let dev = Device::create()?;
        dev.set_name(MY_INTERFACE)?;
     
        Ok(dev)
    })
    // Everything failed, just panic
    .expect("Failed to open device");

// Set the device ip
dev.set_ip([192, 168, 60, 1], [255, 255, 255, 0])
    .expect("Failed to set device ip");

// Setup read buffer
let mtu = dev.get_mtu().unwrap_or(1500);
let mut buf = vec![0; mtu as usize];

// Read a single packet from the device
let amt = dev.read(&mut buf)
    .expect("Failed to read packet");

// Print it
println!("{:#?}", &buf[..amt]);

Implementations

impl Device

pub fn create() -> Result<Self>

Creates a new tap-windows device Example

use tap_windows::Device;

let dev = Device::create()
    .expect("Failed to create device");

println!("{:?}", dev.get_name());

pub fn open(name: &str) -> Result<Self>

Opens an existing tap-windows device by name Example

use tap_windows::Device;

let dev = Device::open("My Own Device")
    .expect("Failed to open device");

println!("{:?}", dev.get_name());

pub fn delete(self) -> Result<()>

Deletes the interface before closing it. By default interfaces are never deleted on Drop, with this you can choose if you want deletion or not Example

use tap_windows::Device;

let dev = Device::create()
    .expect("Failed to create device");

println!("{:?}", dev.get_name());

// Perform a quick cleanup before exiting
dev.delete().expect("Failed to delete device");

pub fn up(&self) -> Result<()>

Sets the status of the interface to connected. Equivalent to .set_status(true)

pub fn down(&self) -> Result<()>

Sets the status of the interface to disconnected. Equivalent to .set_status(false)

pub fn get_mac(&self) -> Result<[u8; 6]>

Retieve the mac of the interface

pub fn get_version(&self) -> Result<[u32; 3]>

Retrieve the version of the driver

pub fn get_mtu(&self) -> Result<u32>

Retieve the mtu of the interface

pub fn get_name(&self) -> Result<String>

Retrieve the name of the interface

pub fn set_name(&self, newname: &str) -> Result<()>

Set the name of the interface

pub fn set_ip<A, B>(&self, address: A, mask: B) -> Result<()> where
    A: Into<Ipv4Addr>,
    B: Into<Ipv4Addr>, 

Set the ip of the interface

use tap_windows::Device;

let dev = Device::create()
    .expect("Failed to create device");

dev.set_ip([192, 168, 60, 1], [255, 255, 255, 0])
    .expect("Failed to set interface ip");

println!("{:?}", dev.get_name());

pub fn set_status(&self, status: bool) -> Result<()>

Set the status of the interface, true for connected, false for disconnected.

Trait Implementations

impl Drop for Device

fn drop(&mut self)

Executes the destructor for this type.

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.

unsafe fn initializer(&self) -> Initializer

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

Determines if this Reader can work with buffers of uninitialized memory.

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

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

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

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

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

Read the exact number of bytes required to fill buf.

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

Creates a "by reference" adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an [Iterator] over its bytes.

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

Creates an adaptor which will chain this stream with another.

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

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

impl Write for Device

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

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

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

Flush 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 Writeer 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

Creates a "by reference" adaptor for this instance of Write.