Struct Enumerator

pub struct Enumerator { /* private fields */ }

An enumeration context.

An Enumerator scans /sys for devices matching its filters. Filters are added to an Enumerator by calling its match_* and nomatch_* methods. After the filters are setup, the scan_devices() method finds devices in /sys that match the filters.

Implementations

impl Enumerator

pub fn new() -> Result<Self>

Creates a new Enumerator.

pub fn with_udev(udev: Udev) -> Result<Self>

Creates a new Enumerator with an existing Udev instance

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

Adds a filter that matches only initialized devices.

pub fn match_subsystem<T: AsRef<OsStr>>(&mut self, subsystem: T) -> Result<()>

Adds a filter that matches only devices that belong to the given kernel subsystem.

pub fn match_attribute<T: AsRef<OsStr>, U: AsRef<OsStr>>( &mut self, attribute: T, value: U, ) -> Result<()>

Adds a filter that matches only devices with the given attribute value.

pub fn match_sysname<T: AsRef<OsStr>>(&mut self, sysname: T) -> Result<()>

Adds a filter that matches only devices with the given kernel device name.

pub fn match_property<T: AsRef<OsStr>, U: AsRef<OsStr>>( &mut self, property: T, value: U, ) -> Result<()>

Adds a filter that matches only devices with the given property value.

pub fn match_tag<T: AsRef<OsStr>>(&mut self, tag: T) -> Result<()>

Adds a filter that matches only devices with the given tag.

pub fn match_parent(&mut self, parent: &Device) -> Result<()>

Includes the parent device and all devices in the subtree of the parent device.

pub fn nomatch_subsystem<T: AsRef<OsStr>>(&mut self, subsystem: T) -> Result<()>

Adds a filter that matches only devices that don’t belong to the given kernel subsystem.

pub fn nomatch_attribute<T: AsRef<OsStr>, U: AsRef<OsStr>>( &mut self, attribute: T, value: U, ) -> Result<()>

Adds a filter that matches only devices that don’t have the the given attribute value.

pub fn add_syspath<T: AsRef<OsStr>>(&mut self, syspath: T) -> Result<()>

Includes the device with the given syspath.

pub fn scan_devices(&mut self) -> Result<List<'_, Enumerator, Device>>

Scans /sys for devices matching the attached filters.

The devices will be sorted in dependency order.

Trait Implementations

impl AsRawWithContext<udev_enumerate> for Enumerator

fn as_raw(&self) -> *mut udev_enumerate

Get a reference of the underlying struct.

fn udev(&self) -> &Udev

The udev context with which this struct was created. This must live at least as long as the struct itself or undefined behavior will result.

fn into_raw_with_context(self) -> (*mut udev, *mut udev_enumerate)

Convert the object into the raw udev pointer and the underlying pointer for this object.

impl Clone for Enumerator

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Drop for Enumerator

fn drop(&mut self)

Executes the destructor for this type.

impl FromRawWithContext<udev_enumerate> for Enumerator

unsafe fn from_raw_with_context(udev: *mut udev, t: *mut udev_enumerate) -> Self

Create an object from a given raw pointer and udev context pointer.