https://github.com/ohadravid/wmi-rs

WMI crate for rust
https://github.com/ohadravid/wmi-rs

Last synced: about 2 months ago
JSON representation

WMI crate for rust

• Host: GitHub
• URL: https://github.com/ohadravid/wmi-rs
• Owner: ohadravid
• License: apache-2.0
• Created: 2018-12-25T11:22:47.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-04-15T02:55:38.000Z (5 months ago)
• Last Synced: 2024-07-19T09:26:43.976Z (2 months ago)
• Language: Rust
• Size: 379 KB
• Stars: 76
• Watchers: 7
• Forks: 23
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
# wmi

[![check](https://github.com/ohadravid/wmi-rs/actions/workflows/check.yml/badge.svg?branch=main)](https://github.com/ohadravid/wmi-rs/actions/workflows/check.yml)[![crates.io](https://img.shields.io/crates/v/wmi.svg)](https://crates.io/crates/wmi)

[![docs.rs](https://docs.rs/wmi/badge.svg)](https://docs.rs/crate/wmi)

WMI (Windows Management Instrumentation) crate for rust.

```toml

# Cargo.toml

[dependencies]

wmi = "0.13"

```

## Examples

Queries can be deserialized into a free-form `HashMap` or a `struct`:

```rust

#![allow(non_camel_case_types)]

#![allow(non_snake_case)]

use serde::Deserialize;

use wmi::{COMLibrary, Variant, WMIConnection, WMIDateTime};

use std::collections::HashMap;

fn main() -> Result<(), Box> {

    let com_con = COMLibrary::new()?;

    let wmi_con = WMIConnection::new(com_con.into())?;

    let results: Vec> = wmi_con.raw_query("SELECT * FROM Win32_OperatingSystem")?;

    for os in results {

        println!("{:#?}", os);

    }

    #[derive(Deserialize, Debug)]

    struct Win32_OperatingSystem {

        Caption: String,

        Name: String,

        CurrentTimeZone: i16,

        Debug: bool,

        EncryptionLevel: u32,

        ForegroundApplicationBoost: u8,

        LastBootUpTime: WMIDateTime,

    }

    let results: Vec = wmi_con.query()?;

    for os in results {

        println!("{:#?}", os);

    }

    Ok(())

}

```

### `chrono` vs `time`

If you prefer to use the `time` crate instead of the default `chrono`, include `wmi` as

```toml

[dependencies]

wmi-rs = { version = "*", default-features = false, features = ["time"] }

```

and use the `WMIOffsetDateTime` wrapper instead of the `WMIDateTime` wrapper.

## Async Queries

WMI supports async queries, with methods

like [ExecAsyncQuery](https://docs.microsoft.com/en-us/windows/win32/api/wbemcli/nf-wbemcli-iwbemservices-execqueryasync).

```rust

#![allow(non_camel_case_types)]

#![allow(non_snake_case)]

use serde::Deserialize;

use wmi::{COMLibrary, Variant, WMIConnection, WMIDateTime};

use std::collections::HashMap;

use futures::executor::block_on;

fn main() -> Result<(), Box> {

    let com_con = COMLibrary::new()?;

    let wmi_con = WMIConnection::new(com_con.into())?;

    block_on(exec_async_query(&wmi_con))?;

    Ok(())

}

async fn exec_async_query(wmi_con: &WMIConnection) -> Result<(), Box> {

    let results: Vec> =

        wmi_con.async_raw_query("SELECT * FROM Win32_OperatingSystem").await?;

    for os in results {

        println!("{:#?}", os);

    }

    #[derive(Deserialize, Debug)]

    struct Win32_OperatingSystem {

        Caption: String,

        Name: String,

        CurrentTimeZone: i16,

        Debug: bool,

        EncryptionLevel: u32,

        ForegroundApplicationBoost: u8,

        LastBootUpTime: WMIDateTime,

    }

    let results: Vec = wmi_con.async_query().await?;

    for os in results {

        println!("{:#?}", os);

    }

    Ok(())

}

```

## License

The `wmi` crate is licensed under either of

```text

Apache License, Version 2.0, (LICENSE-APACHE or https://www.apache.org/licenses/LICENSE-2.0)

MIT license (LICENSE-MIT or https://opensource.org/licenses/MIT)

```

at your option.