Trait SysClass

pub trait SysClass: Sized {
    // Required methods
    fn class() -> &'static str;
    unsafe fn from_path_unchecked(path: PathBuf) -> Self;
    fn path(&self) -> &Path;

    // Provided methods
    fn base() -> &'static str { ... }
    fn dir() -> PathBuf { ... }
    fn from_path(path: &Path) -> Result<Self> { ... }
    fn all() -> Result<Vec<Self>> { ... }
    fn iter() -> Box<dyn Iterator<Item = Result<Self>>>
       where Self: 'static { ... }
    fn new(id: &str) -> Result<Self> { ... }
    fn id(&self) -> &str { ... }
    fn read_file<P: AsRef<Path>>(&self, name: P) -> Result<String> { ... }
    fn parse_file<F: FromStr, P: AsRef<Path>>(&self, name: P) -> Result<F>
       where F::Err: Display { ... }
    fn trim_file<P: AsRef<Path>>(&self, name: P) -> Result<String> { ... }
    fn write_file<P: AsRef<Path>, S: AsRef<[u8]>>(
        &self,
        name: P,
        data: S,
    ) -> Result<()> { ... }
}

Required Methods

fn class() -> &'static str

Return the class of the sys object, the name of a folder in `/sys/${base}``

unsafe fn from_path_unchecked(path: PathBuf) -> Self

Create a sys object from an absolute path without checking path for validity

fn path(&self) -> &Path

Return the path of the sys object

Provided Methods

fn base() -> &'static str

Sets the base directory, which defaults to class.

fn dir() -> PathBuf

Return the path to the sys objects, the full path of a folder in /sys/class

fn from_path(path: &Path) -> Result<Self>

Create a sys object from a path, checking it for validity

fn all() -> Result<Vec<Self>>

Retrieve all of the object instances of a sys class

Examples found in repository

examples/scsi_host.rs (line 5)

fn main() -> io::Result<()> {
    for host in ScsiHost::all()? {
        println!(
            "{} has power management policy \"{:?}\"",
            host.id(),
            host.link_power_management_policy()
        );
    }

    Ok(())
}

examples/pci.rs (line 5)

fn main() -> io::Result<()> {
    for dev in PciDevice::all()? {
        println!("PCI Device: {}", dev.id());
    }

    for dev in PciDriver::iter() {
        let dev = dev?;
        println!("PCI Driver: {}", dev.id());
    }

    Ok(())
}

examples/leds.rs (line 5)

fn main() -> io::Result<()> {
    for dev in Leds::all()? {
        println!(
            "{} brightness: {} / {}",
            dev.id(),
            dev.brightness().unwrap(),
            dev.max_brightness().unwrap()
        );
    }

    Ok(())
}

examples/backlight.rs (line 5)

fn main() -> io::Result<()> {
    for dev in Backlight::all()? {
        println!(
            "{} brightness: {} / {}",
            dev.id(),
            dev.brightness().unwrap(),
            dev.max_brightness().unwrap()
        );
    }

    Ok(())
}

examples/block.rs (line 5)

fn main() -> io::Result<()> {
    for block in Block::all()? {
        if block.has_device() {
            println!("Path: {:?}", block.path());
            println!("  Model: {:?}", block.device_model());
            println!("  Vendor: {:?}", block.device_vendor());
            println!("  Rev: {:?}", block.device_rev());
            println!("  Children: {:#?}", block.children());
        }
    }

    Ok(())
}

fn iter() -> Box<dyn Iterator<Item = Result<Self>>>

where Self: 'static,

Retrieve all of the object instances of a sys class, with a boxed iterator

Examples found in repository

examples/pci.rs (line 9)

fn main() -> io::Result<()> {
    for dev in PciDevice::all()? {
        println!("PCI Device: {}", dev.id());
    }

    for dev in PciDriver::iter() {
        let dev = dev?;
        println!("PCI Driver: {}", dev.id());
    }

    Ok(())
}

examples/net.rs (line 5)

fn main() -> io::Result<()> {
    for dev in Net::iter() {
        let dev = dev?;

        println!("{}: {}", dev.id(), dev.address().unwrap());
        println!("    MTU: {}", dev.mtu().unwrap());
        println!("    Duplex: {:?}", dev.duplex());

        let statistics = dev.statistics();
        println!(
            "    RX: {} MiB",
            statistics.rx_bytes().unwrap() / (1024 * 1024)
        );
        println!(
            "    TX: {} MiB",
            statistics.tx_bytes().unwrap() / (1024 * 1024)
        );
    }

    Ok(())
}

fn new(id: &str) -> Result<Self>

Create a sys object by id, checking it for validity

fn id(&self) -> &str

Return the id of the sys object

Examples found in repository

examples/scsi_host.rs (line 8)

fn main() -> io::Result<()> {
    for host in ScsiHost::all()? {
        println!(
            "{} has power management policy \"{:?}\"",
            host.id(),
            host.link_power_management_policy()
        );
    }

    Ok(())
}

examples/pci.rs (line 6)

fn main() -> io::Result<()> {
    for dev in PciDevice::all()? {
        println!("PCI Device: {}", dev.id());
    }

    for dev in PciDriver::iter() {
        let dev = dev?;
        println!("PCI Driver: {}", dev.id());
    }

    Ok(())
}

examples/leds.rs (line 8)

fn main() -> io::Result<()> {
    for dev in Leds::all()? {
        println!(
            "{} brightness: {} / {}",
            dev.id(),
            dev.brightness().unwrap(),
            dev.max_brightness().unwrap()
        );
    }

    Ok(())
}

examples/backlight.rs (line 8)

fn main() -> io::Result<()> {
    for dev in Backlight::all()? {
        println!(
            "{} brightness: {} / {}",
            dev.id(),
            dev.brightness().unwrap(),
            dev.max_brightness().unwrap()
        );
    }

    Ok(())
}

examples/net.rs (line 8)

fn main() -> io::Result<()> {
    for dev in Net::iter() {
        let dev = dev?;

        println!("{}: {}", dev.id(), dev.address().unwrap());
        println!("    MTU: {}", dev.mtu().unwrap());
        println!("    Duplex: {:?}", dev.duplex());

        let statistics = dev.statistics();
        println!(
            "    RX: {} MiB",
            statistics.rx_bytes().unwrap() / (1024 * 1024)
        );
        println!(
            "    TX: {} MiB",
            statistics.tx_bytes().unwrap() / (1024 * 1024)
        );
    }

    Ok(())
}

fn read_file<P: AsRef<Path>>(&self, name: P) -> Result<String>

Read a file underneath the sys object

fn parse_file<F: FromStr, P: AsRef<Path>>(&self, name: P) -> Result<F>

where F::Err: Display,

Parse a number from a file underneath the sys object

fn trim_file<P: AsRef<Path>>(&self, name: P) -> Result<String>

Read a file underneath the sys object and trim whitespace

fn write_file<P: AsRef<Path>, S: AsRef<[u8]>>( &self, name: P, data: S, ) -> Result<()>

Write a file underneath the sys object

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl SysClass for Backlight

impl SysClass for Block

impl SysClass for DmiId

impl SysClass for HwMon

impl SysClass for Leds

impl SysClass for Net

impl SysClass for PciDevice

impl SysClass for PciDriver

impl SysClass for ScsiHost