Struct TunDevice 

pub struct TunDevice { /* private fields */ }

FIPS TUN device wrapper.

Implementations

impl TunDevice

pub async fn create( config: &TunConfig, address: FipsAddress, ) -> Result<Self, TunError>

Create or open a TUN device.

If the interface already exists, opens it and reconfigures it. Otherwise, creates a new TUN device.

This requires CAP_NET_ADMIN capability (run with sudo or setcap).

pub fn name(&self) -> &str

Get the device name.

pub fn mtu(&self) -> u16

Get the configured MTU.

pub fn address(&self) -> &FipsAddress

Get the FIPS address assigned to this device.

pub fn device(&self) -> &Device

Get a reference to the underlying tun::Device.

pub fn device_mut(&mut self) -> &mut Device

Get a mutable reference to the underlying tun::Device.

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

Read a packet from the TUN device.

Returns the number of bytes read into the buffer, or an io::Error. The buffer should be at least MTU + header size (typically 1500+ bytes).

The tun crate’s Read impl transparently strips the macOS utun packet information header, so this returns a raw IP packet on all platforms.

The raw io::Error is returned so callers can inspect ErrorKind (e.g. WouldBlock) or raw_os_error() without string matching.

pub async fn shutdown(&self) -> Result<(), TunError>

Shutdown and delete the TUN device.

This deletes the interface entirely.

pub fn create_writer( &self, max_mss: u16, path_mtu_lookup: PathMtuLookup, ) -> Result<(TunWriter, TunTx), TunError>

Create a TunWriter for this device.

This duplicates the underlying file descriptor so that reads and writes can happen independently on separate threads. Returns the writer and a channel sender for submitting packets to be written.

max_mss is the global TCP MSS ceiling derived from the local transport_mtu() floor. path_mtu_lookup is a read-only handle to the per-destination path MTU map populated by discovery; the writer reads it on each inbound SYN-ACK to compute a per-flow ceiling that honors learned narrow paths through the mesh.

Trait Implementations

impl Debug for TunDevice

Available on Linux or macOS only.

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

Formats the value using the given formatter.