Struct wintun::Adapter

pub struct Adapter { /* fields omitted */ }

Wrapper around a https://git.zx2c4.com/wintun/about/#wintun_adapter_handle

Implementations

impl Adapter

pub fn create(
    wintun: &Wintun,
    pool: &str,
    name: &str,
    guid: Option<u128>
) -> Result<Arc<Adapter>, WintunError>

Creates a new wintun adapter inside the pool pool with name name

Optionally a GUID can be specified that will become the GUID of this adapter once created. Adapters obtained via this function will be able to return their adapter index via Adapter::get_adapter_index

pub fn open(wintun: &Wintun, name: &str) -> Result<Arc<Adapter>, WintunError>

Attempts to open an existing wintun interface name name.

Adapters opened via this call will have an unknown GUID meaning Adapter::get_adapter_index will always fail because knowing the adapter’s GUID is required to determine its index. Currently a workaround is to delete and re-create a new adapter every time one is needed so that it gets created with a known GUID, allowing Adapter::get_adapter_index to works as expected. There is likely a way to get the GUID of our adapter using the Windows Registry or via the Win32 API, so PR’s that solve this issue are always welcome!

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

Delete an adapter, consuming it in the process

pub fn start_session(
    self: &Arc<Self>,
    capacity: u32
) -> Result<Session, WintunError>

Initiates a new wintun session on the given adapter.

Capacity is the size in bytes of the ring buffer used internally by the driver. Must be a power of two between crate::MIN_RING_CAPACITY and crate::MIN_RING_CAPACITY.

pub fn get_luid(&self) -> u64

Returns the Win32 LUID for this adapter

pub fn get_adapter_index(&self) -> Result<u32, WintunError>

Returns the Win32 interface index of this adapter. Useful for specifying the interface when executing netsh interface ip commands

Trait Implementations

impl Drop for Adapter

fn drop(&mut self)

Executes the destructor for this type.