Struct ctaphid::Device

pub struct Device { /* fields omitted */ }

A connected CTAPHID device.

Implementations

impl Device

pub fn connect(hidapi: &HidApi, device_info: &DeviceInfo) -> Result<Self, Error>

Connects to a HID device, assuming that it is a CTAPHID device.

Generally, it is recommended to use list instead to list all available CTAPHID devices and then connect to one of them using Devices::connect.

pub fn ping(&self, data: &[u8]) -> Result<(), Error>

Pings the device sending the given data and checks that it sends the same data back.

If the data returned by the device does not match the sent data, CommandError::InvalidPingData is returned.

pub fn wink(&self) -> Result<(), Error>

Executes the wink command, causing a vendor-defined action that provides some visual or audible identification of a particular authenticator.

pub fn vendor_command(
    &self,
    command: VendorCommand,
    data: &[u8]
) -> Result<Vec<u8>, Error>

Executes the given vendor-specific command with the given data.

Methods from Deref<Target = DeviceInfo>

pub fn vendor_id(&self) -> u16

Returns the vendor ID of this device.

pub fn product_id(&self) -> u16

Returns the product ID of this device.

Trait Implementations

impl Debug for Device

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

Formats the value using the given formatter.

impl Deref for Device

type Target = DeviceInfo

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.