Struct Device

pub struct Device { /* private fields */ }

Default device abstraction

Implementations

impl Device

pub const fn axis_count(&self) -> u8

Get axis count

pub fn axis_mapping(&self) -> &[AbsoluteAxis; 64]

Get axes mapping

pub fn axis_mapping_at(&self, number: u8) -> AbsoluteAxis

Get axis mapping at index

pub const fn button_count(&self) -> u8

Get button count

pub fn button_mapping(&self) -> &[Key; 512]

Get buttons mapping

pub fn button_mapping_at(&self, number: u8) -> Key

Get button mapping at index

pub fn driver_version(&self) -> u32

Get driver version

pub unsafe fn from_raw_fd(fd: RawFd) -> Result<Self>

Create new device from raw fd

This function expects the file to be opened at least in read mode. Other flags are optional. Non-blocking mode is recommended unless you really don’t want it. Other flags shouldn’t have any impact.

If the file is not a valid device node the will fail gracefully.

Safety

Safety is equivalent to that of std::fs::File::from_raw_fd.

pub fn get_correction_values(&self) -> Result<Vec<Correction>>

Retrieve axes correction values. Wraps get_correction_values.

pub fn get_event(&self) -> Result<DeviceEvent>

Read en event. Wraps get_event.

pub fn identifier(&self) -> &str

Get device identifier

pub fn new(file: File) -> Result<Self>

Create new device from file

This function expects the file to be opened at least in read mode. Other flags are optional. Non-blocking mode is recommended unless you really don’t want it. Other flags shouldn’t have any impact.

If the file is not a valid device node the will fail gracefully.

pub fn open<P: AsRef<Path>>(path: P) -> Result<Self>

Create new device by opening file at path

This function always tries opening the file in read-only and non-blocking mode.

If the file is not a valid device node the will fail gracefully.

pub fn refresh_axis_mapping(&mut self) -> Result<()>

Refresh axis mapping. Wraps get_axis_mapping.

pub fn refresh_button_mapping(&mut self) -> Result<()>

Refresh button mapping. Wraps get_button_mapping.

pub fn refresh_mapping(&mut self) -> Result<()>

Refresh mapping for both axis and buttons

pub fn set_axis_mapping(&mut self, mapping: &[AbsoluteAxis; 64]) -> Result<()>

Set axes mapping. Wraps set_axis_mapping.

pub fn set_axis_mapping_at( &mut self, number: u8, axis: AbsoluteAxis, ) -> Result<()>

Set axis mapping at index. Wraps set_axis_mapping.

pub fn set_button_mapping(&mut self, mapping: &[Key; 512]) -> Result<()>

Set buttons mapping. Wraps set_button_mapping.

pub fn set_button_mapping_at(&mut self, number: u8, button: Key) -> Result<()>

Set button mapping at index. Wraps set_button_mapping.

pub fn set_correction_values(&self, mapping: &[Correction; 64]) -> Result<()>

Set axes correction values. Wraps set_correction_values.

Trait Implementations

impl AsRawFd for Device

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Debug for Device

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

Formats the value using the given formatter.

impl IntoRawFd for Device

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.