Struct Device

Source
pub struct Device { /* private fields */ }
Expand description

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§

Source§

impl Device

Source

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());
Source

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());
Source

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");
Source

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

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

Source

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

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

Source

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

Retieve the mac of the interface

Source

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

Retrieve the version of the driver

Source

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

Retieve the mtu of the interface

Source

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

Retrieve the name of the interface

Source

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

Set the name of the interface

Source

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());
Source

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

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

Trait Implementations§

Source§

impl Drop for Device

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl Read for Device

Source§

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. Read more
1.36.0 · Source§

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

Like read, except that it reads into a slice of buffers. Read more
Source§

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. Read more
1.0.0 · Source§

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. Read more
1.0.0 · Source§

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

Reads all bytes until EOF in this source, appending them to buf. Read more
1.6.0 · Source§

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

Reads the exact number of bytes required to fill buf. Read more
Source§

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. Read more
Source§

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. Read more
1.0.0 · Source§

fn by_ref(&mut self) -> &mut Self
where Self: Sized,

Creates a “by reference” adaptor for this instance of Read. Read more
1.0.0 · Source§

fn bytes(self) -> Bytes<Self>
where Self: Sized,

Transforms this Read instance to an Iterator over its bytes. Read more
1.0.0 · Source§

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

Creates an adapter which will chain this stream with another. Read more
1.0.0 · Source§

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

Creates an adapter which will read at most limit bytes from it. Read more
Source§

impl Write for Device

Source§

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

Writes a buffer into this writer, returning how many bytes were written. Read more
Source§

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

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
1.36.0 · Source§

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

Like write, except that it writes from a slice of buffers. Read more
Source§

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. Read more
1.0.0 · Source§

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

Attempts to write an entire buffer into this writer. Read more
Source§

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. Read more
1.0.0 · Source§

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

Writes a formatted string into this writer, returning any error encountered. Read more
1.0.0 · Source§

fn by_ref(&mut self) -> &mut Self
where Self: Sized,

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

Auto Trait Implementations§

§

impl Freeze for Device

§

impl RefUnwindSafe for Device

§

impl !Send for Device

§

impl !Sync for Device

§

impl Unpin for Device

§

impl UnwindSafe for Device

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.