1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234
use crate::{
connection::WMIConnection,
query::{build_query, FilterValue},
query_sink::{AsyncQueryResultStream, AsyncQueryResultStreamInner, QuerySink},
result_enumerator::IWbemClassWrapper,
WMIResult,
};
use futures::stream::{Stream, StreamExt, TryStreamExt};
use serde::de;
use std::collections::HashMap;
use windows::core::BSTR;
use windows::Win32::System::Wmi::{IWbemObjectSink, WBEM_FLAG_BIDIRECTIONAL};
///
/// ### Additional async methods
///
impl WMIConnection {
/// Wrapper for the [ExecQueryAsync](https://docs.microsoft.com/en-us/windows/win32/api/wbemcli/nf-wbemcli-iwbemservices-execqueryasync)
/// method. Provides safety checks, and returns results
/// as a Stream instead of the original Sink.
///
pub fn exec_query_async_native_wrapper(
&self,
query: impl AsRef<str>,
) -> WMIResult<impl Stream<Item = WMIResult<IWbemClassWrapper>>> {
let query_language = BSTR::from("WQL");
let query = BSTR::from(query.as_ref());
let stream = AsyncQueryResultStreamInner::new();
// The internal RefCount has initial value = 1.
let p_sink = QuerySink {
stream: stream.clone(),
};
let p_sink_handle: IWbemObjectSink = p_sink.into();
unsafe {
// As p_sink's RefCount = 1 before this call,
// p_sink won't be dropped at the end of ExecQueryAsync
self.svc.ExecQueryAsync(
&query_language,
&query,
WBEM_FLAG_BIDIRECTIONAL,
None,
&p_sink_handle,
)?;
}
Ok(AsyncQueryResultStream::new(
stream,
self.clone(),
p_sink_handle,
))
}
/// Async version of [`raw_query`](WMIConnection#method.raw_query)
/// Execute a free-text query and deserialize the results.
/// Can be used either with a struct (like `query` and `filtered_query`),
/// but also with a generic map.
///
/// ```edition2018
/// # use wmi::*;
/// # use std::collections::HashMap;
/// # use futures::executor::block_on;
/// # fn main() -> WMIResult<()> {
/// # block_on(exec_async_query())?;
/// # Ok(())
/// # }
/// #
/// # async fn exec_async_query() -> WMIResult<()> {
/// # let con = WMIConnection::new(COMLibrary::new()?)?;
/// use futures::stream::TryStreamExt;
/// let results: Vec<HashMap<String, Variant>> = con.async_raw_query("SELECT Name FROM Win32_OperatingSystem").await?;
/// # Ok(())
/// # }
/// ```
pub async fn async_raw_query<T>(&self, query: impl AsRef<str>) -> WMIResult<Vec<T>>
where
T: de::DeserializeOwned,
{
self.exec_query_async_native_wrapper(query)?
.map(|item| match item {
Ok(wbem_class_obj) => wbem_class_obj.into_desr(),
Err(e) => Err(e),
})
.try_collect::<Vec<_>>()
.await
}
/// Query all the objects of type T.
///
/// ```edition2018
/// # use wmi::*;
/// # use std::collections::HashMap;
/// # use futures::executor::block_on;
/// # fn main() -> WMIResult<()> {
/// # block_on(exec_async_query())?;
/// # Ok(())
/// # }
/// #
/// # async fn exec_async_query() -> WMIResult<()> {
/// # let con = WMIConnection::new(COMLibrary::new()?)?;
/// use serde::Deserialize;
/// #[derive(Deserialize, Debug)]
/// struct Win32_Process {
/// Name: String,
/// }
///
/// let procs: Vec<Win32_Process> = con.async_query().await?;
/// # Ok(())
/// # }
/// ```
pub async fn async_query<T>(&self) -> WMIResult<Vec<T>>
where
T: de::DeserializeOwned,
{
let query_text = build_query::<T>(None)?;
self.async_raw_query(&query_text).await
}
/// Query all the objects of type T, while filtering according to `filters`.
///
pub async fn async_filtered_query<T>(
&self,
filters: &HashMap<String, FilterValue>,
) -> WMIResult<Vec<T>>
where
T: de::DeserializeOwned,
{
let query_text = build_query::<T>(Some(filters))?;
self.async_raw_query(&query_text).await
}
}
#[allow(non_snake_case)]
#[allow(non_camel_case_types)]
#[cfg(test)]
mod tests {
use crate::{tests::fixtures::*, Variant};
use futures::stream::{self, StreamExt};
use serde::Deserialize;
use std::collections::HashMap;
#[async_std::test]
async fn async_it_works_async() {
let wmi_con = wmi_con();
let result = wmi_con
.exec_query_async_native_wrapper("SELECT OSArchitecture FROM Win32_OperatingSystem")
.unwrap()
.collect::<Vec<_>>()
.await;
assert_eq!(result.len(), 1);
}
#[tokio::test]
async fn async_it_works_async_tokio() {
let wmi_con = wmi_con();
let result = wmi_con
.exec_query_async_native_wrapper("SELECT OSArchitecture FROM Win32_OperatingSystem")
.unwrap()
.collect::<Vec<_>>()
.await;
assert_eq!(result.len(), 1);
}
#[async_std::test]
async fn async_it_handles_invalid_query() {
let wmi_con = wmi_con();
let result = wmi_con
.exec_query_async_native_wrapper("invalid query")
.unwrap()
.collect::<Vec<_>>()
.await;
assert_eq!(result.len(), 0);
}
#[async_std::test]
async fn async_it_provides_raw_query_result() {
let wmi_con = wmi_con();
let results: Vec<HashMap<String, Variant>> = wmi_con
.async_raw_query("SELECT * FROM Win32_GroupUser")
.await
.unwrap();
for res in results {
match res.get("GroupComponent") {
Some(Variant::String(s)) => assert_ne!(s, ""),
_ => assert!(false),
}
match res.get("PartComponent") {
Some(Variant::String(s)) => assert_ne!(s, ""),
_ => assert!(false),
}
}
}
#[tokio::test]
async fn async_it_works_async_tokio_concurrent() {
let wmi_con = wmi_con();
// We want to actually consume a bunch of data from WMI.
#[allow(unused)]
#[derive(Deserialize, Debug)]
struct Win32_OperatingSystem {
Name: String,
SerialNumber: String,
OSArchitecture: String,
BootDevice: String,
MUILanguages: Vec<String>,
}
// Using buffer_unordered(1) will take 2 seconds instead of 0.2 seconds.
let results: Vec<Win32_OperatingSystem> = stream::iter(0..150)
.map(|_| async {
let result: Vec<Win32_OperatingSystem> = wmi_con.async_query().await.unwrap();
result.into_iter().next().unwrap()
})
.buffer_unordered(50)
.collect()
.await;
assert_eq!(results.len(), 150);
}
}