Adding `nvme_amz` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add nvme-amz

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

nvme-amz = "0.4.0"

The nvme_amz library will be automatically available globally. Read the nvme_amz library documentation.

Back to the crate overview.

Readme

nvme-amz

A Rust library to probe NVMe devices in Amazon EC2.

It provides functionality similar to that of the ebsnvme-id command but adds information about instance store devices, not only EBS.

To use this library, you must define one of the features ioctl-nix or ioctl-rustix. Either nix or rustix will be pulled in as dependencies, respectively. The chosen library is used to make ioctl system calls.

The library implements TryFrom<File> for Nvme, so this is how to interact with it. For example:

use nvme_amz::Nvme;

fn main() {
    let file = File::open("/dev/nvme0").expect("unable to open device");
    let nvme: Nvme = file.try_into().expect("unable to probe device");
    println!("{:?}", nvme);
}

Output for an EBS volume:

Nvme { names: Names { device_name: Some("sda"), virtual_name: None }, model: AmazonElasticBlockStore, vendor_id: VendorId(7439) }

Output for an instance store volume:

Nvme { names: Names { device_name: Some("sdb"), virtual_name: Some("ephemeral0") }, model: AmazonInstanceStore, vendor_id: VendorId(7439) }

Adding nvme_amz library as a dependency

Adding `nvme_amz` library as a dependency