From f765a22a664c373aaaff24ca05e7d2ee6d5cadd2 Mon Sep 17 00:00:00 2001 From: nidhih Date: Fri, 26 May 2023 11:10:39 +0530 Subject: [PATCH 1/2] documentation fixes --- src/operating_system/file_system.rs | 2 +- src/operating_system/networking.rs | 2 +- src/operating_system/operating_system_settings.rs | 4 ++-- src/operating_system/product_activation.rs | 4 ++-- src/operating_system/scheduler_jobs.rs | 2 +- src/operating_system/security.rs | 2 +- src/operating_system/start_menu.rs | 2 +- 7 files changed, 9 insertions(+), 9 deletions(-) diff --git a/src/operating_system/file_system.rs b/src/operating_system/file_system.rs index 1cd5f08..71fb0c0 100644 --- a/src/operating_system/file_system.rs +++ b/src/operating_system/file_system.rs @@ -90,7 +90,7 @@ update!(MappedLogicalDisks, mapped_logical_disks); #[derive(Deserialize, Serialize, Debug, Clone)] pub struct QuotaSettings { /// Sequence of windows quota settings - pub quota_settings: Vec, + pub quota_settings: Vec, /// When was the record last updated pub last_updated: SystemTime, } diff --git a/src/operating_system/networking.rs b/src/operating_system/networking.rs index ddbf03d..5b1d1fe 100644 --- a/src/operating_system/networking.rs +++ b/src/operating_system/networking.rs @@ -513,7 +513,7 @@ pub struct Win32_NetworkProtocol { pub SupportsQualityofService: Option, } -/// The Win32_NTDomain WMI class represents a Windows domain. +/// The `Win32_NTDomain` WMI class represents a Windows domain. /// /// #[derive(Default, Deserialize, Serialize, Debug, Clone)] diff --git a/src/operating_system/operating_system_settings.rs b/src/operating_system/operating_system_settings.rs index 43ec323..a093fd8 100644 --- a/src/operating_system/operating_system_settings.rs +++ b/src/operating_system/operating_system_settings.rs @@ -123,7 +123,7 @@ pub struct StartupCommands { update!(StartupCommands, startup_commands); -/// The Win32_BootConfiguration WMI class represents the boot configuration of a computer system running Windows. +/// The `Win32_BootConfiguration` WMI class represents the boot configuration of a computer system running Windows. /// /// #[derive(Default, Deserialize, Serialize, Debug, Clone)] @@ -156,7 +156,7 @@ pub struct Win32_BootConfiguration { pub TempDirectory: Option, } -/// The Win32_ComputerSystem WMI class represents a computer system running Windows. +/// The `Win32_ComputerSystem` WMI class represents a computer system running Windows. /// /// #[derive(Default, Deserialize, Serialize, Debug, Clone)] diff --git a/src/operating_system/product_activation.rs b/src/operating_system/product_activation.rs index dd1ee87..957c5a3 100644 --- a/src/operating_system/product_activation.rs +++ b/src/operating_system/product_activation.rs @@ -60,7 +60,7 @@ pub struct Win32_Proxy { pub SettingID: Option, } -/// The Win32_WindowsProductActivation WMI class contains properties and methods related to Windows +/// The `Win32_WindowsProductActivation` WMI class contains properties and methods related to Windows /// Product Activation (WPA), such as activation state and grace period. This class also provides the /// ability to activate the customer's computer online and offline. /// @@ -97,6 +97,6 @@ pub struct Win32_WindowsProductActivation { /// System whose WPA properties and methods are to be accessed. This property is a string that specifies /// the name of the computer or its IP address. pub ServerName: Option, - /// Identifier by which the CIM_Setting object is known. + /// Identifier by which the `CIM_Setting` object is known. pub SettingID: Option, } \ No newline at end of file diff --git a/src/operating_system/scheduler_jobs.rs b/src/operating_system/scheduler_jobs.rs index 15cface..6333187 100644 --- a/src/operating_system/scheduler_jobs.rs +++ b/src/operating_system/scheduler_jobs.rs @@ -219,7 +219,7 @@ pub struct Win32_LocalTime { pub Year: Option, } -/// The Win32_UTCTimeWMI class describes a point in time that is returned as Win32_UTCTime objects +/// The `Win32_UTCTimeWMI` class describes a point in time that is returned as Win32_UTCTime objects /// that result from a query. These are returned as the value for the TargetInstance property in the /// __InstanceModificationEvent system class. The Hour property is returned as the Coordinated /// Universal Time (UTC) time on a 24 hour clock. diff --git a/src/operating_system/security.rs b/src/operating_system/security.rs index 0ae2935..c763f3e 100644 --- a/src/operating_system/security.rs +++ b/src/operating_system/security.rs @@ -55,7 +55,7 @@ update!(LogicalFileSecuritySettings, logical_file_security_settings); /// Represents the state of Windows LogicalShareSecuritySettings #[derive(Deserialize, Serialize, Debug, Clone)] pub struct LogicalShareSecuritySettings { - /// Represents sequence of Windows `LogicalFileSecuritySettings` + /// Represents sequence of Windows `LogicalShareSecuritySettings` pub logical_share_security_settings: Vec, /// When was the record last updated pub last_updated: SystemTime, diff --git a/src/operating_system/start_menu.rs b/src/operating_system/start_menu.rs index e9d2cf4..afe9998 100644 --- a/src/operating_system/start_menu.rs +++ b/src/operating_system/start_menu.rs @@ -39,7 +39,7 @@ update!(LogicalProgramGroupItems, logical_program_group_items); /// Represents the state of Windows ProgramGroupOrItems #[derive(Deserialize, Serialize, Debug, Clone)] pub struct ProgramGroupOrItems { - /// Represents sequence of Windows `LogicalProgramGroupItems` + /// Represents sequence of Windows `ProgramGroupOrItems` pub program_group_or_items: Vec, /// When was the record last updated pub last_updated: SystemTime, From 126985add3ff9d74f2941ad8eab79317852adc8d Mon Sep 17 00:00:00 2001 From: nidhih Date: Fri, 26 May 2023 11:30:29 +0530 Subject: [PATCH 2/2] clippy changes --- src/bin/get_fields.rs | 4 +- src/operating_system/desktop.rs | 2 +- src/operating_system/event_log.rs | 4 +- src/operating_system/file_system.rs | 16 +++--- src/operating_system/job_objects.rs | 14 ++--- src/operating_system/memory_and_pagefiles.rs | 6 +-- .../multimedia_audio_visual.rs | 2 +- src/operating_system/networking.rs | 16 +++--- .../operating_system_settings.rs | 16 +++--- src/operating_system/product_activation.rs | 2 +- src/operating_system/scheduler_jobs.rs | 16 +++--- src/operating_system/security.rs | 54 +++++++++---------- src/operating_system/shares.rs | 6 +-- .../software_license_provider.rs | 6 +-- src/operating_system/start_menu.rs | 6 +-- src/operating_system/storage.rs | 8 +-- src/operating_system/users.rs | 4 +- 17 files changed, 91 insertions(+), 91 deletions(-) diff --git a/src/bin/get_fields.rs b/src/bin/get_fields.rs index b2aa226..33a791a 100644 --- a/src/bin/get_fields.rs +++ b/src/bin/get_fields.rs @@ -1,6 +1,6 @@ // cargo run --bin get_fields --release -use wmi::*; +use wmi::{COMLibrary, WMIConnection}; use std::collections::HashMap; use wmi::Variant; @@ -8,5 +8,5 @@ pub fn main() { let wmi_con = WMIConnection::new(COMLibrary::new().unwrap()).unwrap(); let results: Vec> = wmi_con.raw_query("SELECT * FROM Win32_ServerConnection").unwrap(); - print!("{:?}", results); + print!("{results:?}"); } \ No newline at end of file diff --git a/src/operating_system/desktop.rs b/src/operating_system/desktop.rs index 0297210..d220dfc 100644 --- a/src/operating_system/desktop.rs +++ b/src/operating_system/desktop.rs @@ -35,7 +35,7 @@ pub struct Environments { update!(Environments, environments); -/// Represents the state of Windows TimeZone +/// Represents the state of Windows `TimeZone` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct TimeZones { /// Sequence of windows TimeZone states diff --git a/src/operating_system/event_log.rs b/src/operating_system/event_log.rs index 1a455e6..b9bbd82 100644 --- a/src/operating_system/event_log.rs +++ b/src/operating_system/event_log.rs @@ -13,7 +13,7 @@ use serde::{Deserialize, Serialize}; use std::time::SystemTime; use wmi::{COMLibrary, WMIConnection, WMIDateTime}; -/// Represents the state of Windows NTEventlogFiles +/// Represents the state of Windows `NTEventlogFiles` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct NTEventlogFiles { /// Represents data stored in a Windows Event log file @@ -24,7 +24,7 @@ pub struct NTEventlogFiles { update!(NTEventlogFiles, nt_event_log_files); -/// Represents the state of Windows NTLogEvents +/// Represents the state of Windows `NTLogEvents` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct NTLogEvents { /// Represents sequence of Windows `NTLogEvents` diff --git a/src/operating_system/file_system.rs b/src/operating_system/file_system.rs index 71fb0c0..5d191f1 100644 --- a/src/operating_system/file_system.rs +++ b/src/operating_system/file_system.rs @@ -121,7 +121,7 @@ update!(Volumes, volumes); /// The `Win32_Directory` WMI class represents a directory entry on a computer system running Windows. /// A directory is a type of file that logically groups data files and provides path information for -/// the grouped files. Example: C:\TEMP. Win32_Directory does not include directories of network +/// the grouped files. Example: C:\TEMP. `Win32_Directory` does not include directories of network /// drives. /// /// @@ -271,13 +271,13 @@ pub struct Win32_Directory { /// Directory resolution is performed as follows: /// /// - Root destination directories: -/// The root directory entries are those with a null Directory_Parent value or a Directory_Parent value identical to the Directory value. +/// The root directory entries are those with a null `Directory_Parent` value or a `Directory_Parent` value identical to the Directory value. /// The value in the Directory property is interpreted as the name of a property /// defining the location of the destination directory. /// If the property is defined, the destination directory is resolved to the property's value. /// If the property is undefined, the ROOTDRIVE property is used instead to resolve the path. /// - Root source directories: -/// The value of the DefaultDir column for root entries is interpreted as the name of a property +/// The value of the `DefaultDir` column for root entries is interpreted as the name of a property /// defining the source location of this directory. /// This property must be defined or an error will occur. /// - Nonroot destination directories: @@ -285,11 +285,11 @@ pub struct Win32_Directory { /// defining the location of the destination. /// If the property is defined, the destination directory is resolved to the property's value. /// If the property is not defined, -/// the destination directory is resolved to a subdirectory beneath the resolved destination directory for the Directory_Parent entry. -/// The DefaultDir value defines the name of the subdirectory. +/// the destination directory is resolved to a subdirectory beneath the resolved destination directory for the `Directory_Parent` entry. +/// The `DefaultDir` value defines the name of the subdirectory. /// - Nonroot source directories: -/// The source directory for a nonroot directory is resolved to a subdirectory of the resolved source directory for the Directory_Parent entry. -/// Again, the DefaultDir value defines the name of the subdirectory. +/// The source directory for a nonroot directory is resolved to a subdirectory of the resolved source directory for the `Directory_Parent` entry. +/// Again, the `DefaultDir` value defines the name of the subdirectory. /// /// #[derive(Default, Deserialize, Serialize, Debug, Clone)] @@ -1475,7 +1475,7 @@ pub struct Win32_ShortcutFile { /// A volume is formatted by using a file system, such as FAT or NTFS, /// and might have a drive letter assigned to it. /// One hard disk can have multiple volumes, and volumes can span multiple physical disks. -/// The Win32_Volume class does not support disk drive management. +/// The `Win32_Volume` class does not support disk drive management. /// /// Windows XP and earlier: This class is not available. /// diff --git a/src/operating_system/job_objects.rs b/src/operating_system/job_objects.rs index 3134189..88cd5cf 100644 --- a/src/operating_system/job_objects.rs +++ b/src/operating_system/job_objects.rs @@ -22,7 +22,7 @@ use serde::{Deserialize, Serialize}; use std::time::SystemTime; use wmi::{COMLibrary, WMIConnection}; -/// Represents the state of Windows LUIDs +/// Represents the state of Windows `LUIDs` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct LUIDs { /// Represents sequence of Windows `LUIDs` @@ -33,10 +33,10 @@ pub struct LUIDs { update!(LUIDs, luids); -/// Represents the state of Windows LUIDandAttributes +/// Represents the state of Windows `LUIDandAttributes` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct LUIDandAttributes { - /// Represents sequence of Windows `LUIDs` + /// Represents sequence of Windows `LUIDandAttributes` pub luid_and_attributes: Vec, /// When was the record last updated pub last_updated: SystemTime, @@ -44,7 +44,7 @@ pub struct LUIDandAttributes { update!(LUIDandAttributes, luid_and_attributes); -/// Represents the state of Windows NamedJobObjects +/// Represents the state of Windows `NamedJobObjects` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct NamedJobObjects { /// Represents sequence of Windows `NamedJobObjects` @@ -55,7 +55,7 @@ pub struct NamedJobObjects { update!(NamedJobObjects, named_job_objects); -/// Represents the state of Windows NamedJobObjectActgInfos +/// Represents the state of Windows `NamedJobObjectActgInfos` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct NamedJobObjectActgInfos { /// Represents sequence of Windows `NamedJobObjectActgInfos` @@ -66,7 +66,7 @@ pub struct NamedJobObjectActgInfos { update!(NamedJobObjectActgInfos, named_job_object_actg_infos); -/// Represents the state of Windows NamedJobObjectLimitSettings +/// Represents the state of Windows `NamedJobObjectLimitSettings` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct NamedJobObjectLimitSettings { /// Represents sequence of Windows `NamedJobObjectLimitSettings` @@ -204,7 +204,7 @@ pub struct Win32_NamedJobObjectActgInfo { pub WriteTransferCount: Option, } -/// The Win32_NamedJobObjectLimitSetting WMI class represents the limit settings for a job object. +/// The `Win32_NamedJobObjectLimitSetting` WMI class represents the limit settings for a job object. /// /// #[derive(Default, Deserialize, Serialize, Debug, Clone)] diff --git a/src/operating_system/memory_and_pagefiles.rs b/src/operating_system/memory_and_pagefiles.rs index c5f7d93..0f42168 100644 --- a/src/operating_system/memory_and_pagefiles.rs +++ b/src/operating_system/memory_and_pagefiles.rs @@ -12,7 +12,7 @@ use serde::{Deserialize, Serialize}; use std::time::SystemTime; use wmi::{COMLibrary, WMIConnection, WMIDateTime}; -/// Represents the state of Windows PageFiles +/// Represents the state of Windows `PageFiles` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct PageFiles { /// Represents sequence of Windows `PageFiles` @@ -23,7 +23,7 @@ pub struct PageFiles { update!(PageFiles, pagefiles); -/// Represents the state of Windows PageFileSettings +/// Represents the state of Windows `PageFileSettings` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct PageFileSettings { /// Represents the Windows `PageFileSettings` @@ -34,7 +34,7 @@ pub struct PageFileSettings { update!(PageFileSettings, pagefile_settings); -/// Represents the state of Windows PageFileUsages +/// Represents the state of Windows `PageFileUsages` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct PageFileUsages { /// Represents the Windows `PageFileUsages` details diff --git a/src/operating_system/multimedia_audio_visual.rs b/src/operating_system/multimedia_audio_visual.rs index d6db016..5a0f11f 100644 --- a/src/operating_system/multimedia_audio_visual.rs +++ b/src/operating_system/multimedia_audio_visual.rs @@ -9,7 +9,7 @@ use serde::{Deserialize, Serialize}; use std::time::SystemTime; use wmi::{COMLibrary, WMIConnection, WMIDateTime}; -/// Represents the state of Windows CodecFiles +/// Represents the state of Windows `CodecFiles` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct CodecFiles { /// Represents sequence of Windows `CodecFiles` diff --git a/src/operating_system/networking.rs b/src/operating_system/networking.rs index 5b1d1fe..7e504f0 100644 --- a/src/operating_system/networking.rs +++ b/src/operating_system/networking.rs @@ -18,7 +18,7 @@ use serde::{Deserialize, Serialize}; use std::time::SystemTime; use wmi::{COMLibrary, WMIConnection, WMIDateTime}; -/// Represents the state of Windows IP4PersistedRouteTables +/// Represents the state of Windows `IP4PersistedRouteTables` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct IP4PersistedRouteTables { /// Represents sequence of Windows `IP4PersistedRouteTables` @@ -29,7 +29,7 @@ pub struct IP4PersistedRouteTables { update!(IP4PersistedRouteTables, ip4_persisted_route_tables); -/// Represents the state of Windows IP4RouteTables +/// Represents the state of Windows `IP4RouteTables` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct IP4RouteTables { /// Represents sequence of Windows `IP4RouteTables` @@ -40,7 +40,7 @@ pub struct IP4RouteTables { update!(IP4RouteTables, ip4_route_tables); -/// Represents the state of Windows NetworkClients +/// Represents the state of Windows `NetworkClients` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct NetworkClients { /// Represents sequence of Windows `NetworkClients` @@ -51,7 +51,7 @@ pub struct NetworkClients { update!(NetworkClients, nework_clients); -/// Represents the state of Windows NetworkConnections +/// Represents the state of Windows `NetworkConnections` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct NetworkConnections { /// Represents sequence of Windows `NetworkConnections` @@ -62,7 +62,7 @@ pub struct NetworkConnections { update!(NetworkConnections, nework_connections); -/// Represents the state of Windows NetworkProtocols +/// Represents the state of Windows `NetworkProtocols` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct NetworkProtocols { /// Represents sequence of Windows `NetworkProtocols` @@ -73,7 +73,7 @@ pub struct NetworkProtocols { update!(NetworkProtocols, nework_protocols); -/// Represents the state of Windows NTDomains +/// Represents the state of Windows `NTDomains` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct NTDomains { /// Represents sequence of Windows `NTDomains` @@ -84,7 +84,7 @@ pub struct NTDomains { update!(NTDomains, nt_domains); -/// Represents the state of Windows IP4RouteTableEvents +/// Represents the state of Windows `IP4RouteTableEvents` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct IP4RouteTableEvents { /// Represents sequence of Windows `IP4RouteTableEvents` @@ -102,7 +102,7 @@ update!(IP4RouteTableEvents, ip4_route_table_events); /// /// Persistent entries are automatically inserted again in the route table each time the route table /// is rebuilt. The operating system stores persistent routes in the registry. An entry can be removed -/// through the method call SWbemServices.Delete for scripting or IWbemServices::DeleteInstance for C++ +/// through the method call SWbemServices.Delete for scripting or `IWbemServices::DeleteInstance` for C++ /// programming. /// /// This class is only applicable to IPv4 and does not return IPX or IPv6 data. diff --git a/src/operating_system/operating_system_settings.rs b/src/operating_system/operating_system_settings.rs index a093fd8..c50604c 100644 --- a/src/operating_system/operating_system_settings.rs +++ b/src/operating_system/operating_system_settings.rs @@ -35,7 +35,7 @@ use serde::{Deserialize, Serialize}; use std::time::SystemTime; use wmi::{COMLibrary, WMIConnection, WMIDateTime}; -/// Represents the state of Windows BootConfigurations +/// Represents the state of Windows `BootConfigurations` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct BootConfigurations { /// Represents sequence of Windows `BootConfigurations` @@ -46,7 +46,7 @@ pub struct BootConfigurations { update!(BootConfigurations, boot_configurations); -/// Represents the state of Windows ComputerSystems +/// Represents the state of Windows `ComputerSystems` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct ComputerSystems { /// Represents sequence of Windows `ComputerSystems` @@ -57,7 +57,7 @@ pub struct ComputerSystems { update!(ComputerSystems, computer_systems); -/// Represents the state of Windows ComputerSystemProducts +/// Represents the state of Windows `ComputerSystemProducts` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct ComputerSystemProducts { /// Represents sequence of Windows `ComputerSystemProducts` @@ -68,7 +68,7 @@ pub struct ComputerSystemProducts { update!(ComputerSystemProducts, computer_system_products); -/// Represents the state of Windows LoadOrderGroups +/// Represents the state of Windows `LoadOrderGroups` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct LoadOrderGroups { /// Represents sequence of Windows `LoadOrderGroups` @@ -79,7 +79,7 @@ pub struct LoadOrderGroups { update!(LoadOrderGroups, load_order_groups); -/// Represents the state of Windows OperatingSystems +/// Represents the state of Windows `OperatingSystems` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct OperatingSystems { /// Represents sequence of Windows `OperatingSystems` @@ -90,7 +90,7 @@ pub struct OperatingSystems { update!(OperatingSystems, operating_systems); -/// Represents the state of Windows OSRecoveryConfigurations +/// Represents the state of Windows `OSRecoveryConfigurations` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct OSRecoveryConfigurations { /// Represents sequence of Windows `OSRecoveryConfigurations` @@ -101,7 +101,7 @@ pub struct OSRecoveryConfigurations { update!(OSRecoveryConfigurations, os_recovery_configurations); -/// Represents the state of Windows QuickFixEngineerings +/// Represents the state of Windows `QuickFixEngineerings` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct QuickFixEngineerings { /// Represents sequence of Windows `QuickFixEngineerings` @@ -112,7 +112,7 @@ pub struct QuickFixEngineerings { update!(QuickFixEngineerings, quick_fix_engineerings); -/// Represents the state of Windows StartupCommands +/// Represents the state of Windows `StartupCommands` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct StartupCommands { /// Represents sequence of Windows `StartupCommands` diff --git a/src/operating_system/product_activation.rs b/src/operating_system/product_activation.rs index 957c5a3..7783c80 100644 --- a/src/operating_system/product_activation.rs +++ b/src/operating_system/product_activation.rs @@ -24,7 +24,7 @@ pub struct Proxys { update!(Proxys, proxys); -/// Represents the state of Windows WindowsProductActivations +/// Represents the state of Windows `WindowsProductActivations` /// /// Note: this class doesn't exist anymore #[derive(Deserialize, Serialize, Debug, Clone)] diff --git a/src/operating_system/scheduler_jobs.rs b/src/operating_system/scheduler_jobs.rs index 6333187..3d6519f 100644 --- a/src/operating_system/scheduler_jobs.rs +++ b/src/operating_system/scheduler_jobs.rs @@ -10,7 +10,7 @@ use serde::{Deserialize, Serialize}; use std::time::SystemTime; use wmi::{COMLibrary, WMIConnection, WMIDateTime}; -/// Represents the state of Windows ScheduledJobs +/// Represents the state of Windows `ScheduledJobs` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct ScheduledJobs { /// Represents sequence of Windows `ScheduledJobs` @@ -21,7 +21,7 @@ pub struct ScheduledJobs { update!(ScheduledJobs, scheduled_jobs); -/// Represents the state of Windows LocalTimes +/// Represents the state of Windows `LocalTimes` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct LocalTimes { /// Represents sequence of Windows `LocalTimes` @@ -32,7 +32,7 @@ pub struct LocalTimes { update!(LocalTimes, local_times); -/// Represents the state of Windows UTCTimes +/// Represents the state of Windows `UTCTimes` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct UTCTimes { /// Represents sequence of Windows `UTCTimes` @@ -45,7 +45,7 @@ update!(UTCTimes, utc_times); /// The `Win32_ScheduledJob` WMI class represents a job created with the `AT` command. /// -/// Note: The Win32_ScheduledJob class does not represent a job created with the Scheduled Task Wizard +/// Note: The `Win32_ScheduledJob` class does not represent a job created with the Scheduled Task Wizard /// from the Control Panel. You cannot change a task created by WMI in the Scheduled Tasks UI. /// /// @@ -186,7 +186,7 @@ pub struct Win32_ScheduledJob { } /// The `Win32_LocalTime` WMI class describes a point in time returned as `Win32_LocalTime` objects that result -/// from a query. These are returned as the value for the `TargetInstance` property in the __InstanceModificationEvent +/// from a query. These are returned as the value for the `TargetInstance` property in the `__InstanceModificationEvent` /// system class. The Hour property is returned as the local time on a 24-hour clock. /// /// Note: The smallest time segment supported is 1 second. @@ -219,9 +219,9 @@ pub struct Win32_LocalTime { pub Year: Option, } -/// The `Win32_UTCTimeWMI` class describes a point in time that is returned as Win32_UTCTime objects -/// that result from a query. These are returned as the value for the TargetInstance property in the -/// __InstanceModificationEvent system class. The Hour property is returned as the Coordinated +/// The `Win32_UTCTimeWMI` class describes a point in time that is returned as `Win32_UTCTime` objects +/// that result from a query. These are returned as the value for the `TargetInstance` property in the +/// `__InstanceModificationEvent` system class. The Hour property is returned as the Coordinated /// Universal Time (UTC) time on a 24 hour clock. /// /// Note: The smallest time segment supported is a second. diff --git a/src/operating_system/security.rs b/src/operating_system/security.rs index c763f3e..b76a2d0 100644 --- a/src/operating_system/security.rs +++ b/src/operating_system/security.rs @@ -2,28 +2,28 @@ //! //! | Class | Description | //! |-------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------| -//! | [**Win32\_AccountSID**](/previous-versions/windows/desktop/secrcw32prov/win32-accountsid) | Association class
Relates a security account instance with a security descriptor instance.
| -//! | [**Win32\_ACE**](/previous-versions/windows/desktop/secrcw32prov/win32-ace) | Instance class
Represents an access control entry (ACE).
| -//! | [**Win32\_LogicalFileAccess**](/previous-versions/windows/desktop/secrcw32prov/win32-logicalfileaccess) | Association class
Relates the security settings of a file or directory and one member of its discretionary access control list (DACL).
| -//! | [**Win32\_LogicalFileAuditing**](/previous-versions/windows/desktop/secrcw32prov/win32-logicalfileauditing) | Association class
Relates the security settings of a file or directory one member of its system access control list (SACL).
| -//! | [**Win32\_LogicalFileGroup**](/previous-versions/windows/desktop/secrcw32prov/win32-logicalfilegroup) | Association class
Relates the security settings of a file or directory and its group.
| -//! | [**Win32\_LogicalFileOwner**](/previous-versions/windows/desktop/secrcw32prov/win32-logicalfileowner) | Association class
Relates the security settings of a file or directory and its owner.
| -//! | [**Win32\_LogicalFileSecuritySetting**](/previous-versions/windows/desktop/secrcw32prov/win32-logicalfilesecuritysetting) | Instance class
Represents security settings for a logical file.
| -//! | [**Win32\_LogicalShareAccess**](/previous-versions/windows/desktop/secrcw32prov/win32-logicalshareaccess) | Association class
Relates the security settings of a share and one member of its DACL.
| -//! | [**Win32\_LogicalShareAuditing**](/previous-versions/windows/desktop/secrcw32prov/win32-logicalshareauditing) | Association class
Relates the security settings of a share and one member of its SACL.
| -//! | [**Win32\_LogicalShareSecuritySetting**](/previous-versions/windows/desktop/secrcw32prov/win32-logicalsharesecuritysetting) | Instance class
Represents security settings for a logical file.
| -//! | [**Win32\_PrivilegesStatus**](win32-privilegesstatus) | Instance class
Represents information about the privileges required to complete an operation.
| -//! | [**Win32\_SecurityDescriptor**](/previous-versions/windows/desktop/secrcw32prov/win32-securitydescriptor) | Instance class
Represents a structural representation of a [**SECURITY\_DESCRIPTOR**](/windows/desktop/api/winnt/ns-winnt-security_descriptor).
| -//! | [**Win32\_SecuritySetting**](/previous-versions/windows/desktop/secrcw32prov/win32-securitysetting) | Instance class
Represents security settings for a managed element.
| -//! | [**Win32\_SecuritySettingAccess**](/previous-versions/windows/desktop/secrcw32prov/win32-securitysettingaccess) | Instance class
Represents the rights granted and denied to a trustee for a given object.
| -//! | [**Win32\_SecuritySettingAuditing**](/previous-versions/windows/desktop/secrcw32prov/win32-securitysettingauditing) | Instance class
Represents the auditing for a given trustee on a given object.
| -//! | [**Win32\_SecuritySettingGroup**](/previous-versions/windows/desktop/secrcw32prov/win32-securitysettinggroup) | Association class
Relates the security of an object and its group.
| -//! | [**Win32\_SecuritySettingOfLogicalFile**](/previous-versions/windows/desktop/secrcw32prov/win32-securitysettingoflogicalfile) | Instance class
Represents security settings of a file or directory object.
| -//! | [**Win32\_SecuritySettingOfLogicalShare**](/previous-versions/windows/desktop/secrcw32prov/win32-securitysettingoflogicalshare) | Instance class
Represents security settings of a shared object.
| -//! | [**Win32\_SecuritySettingOfObject**](/previous-versions/windows/desktop/secrcw32prov/win32-securitysettingofobject) | Association class
Relates an object to its security settings.
| -//! | [**Win32\_SecuritySettingOwner**](/previous-versions/windows/desktop/secrcw32prov/win32-securitysettingowner) | Association class
Relates the security settings of an object and its owner.
| -//! | [**Win32\_SID**](/previous-versions/windows/desktop/secrcw32prov/win32-sid) | Instance class
Represents an arbitrary SID.
| -//! | [**Win32\_Trustee**](/previous-versions/windows/desktop/secrcw32prov/win32-trustee) | Instance class
Represents a trustee.
| +//! | [**`Win32\_AccountSID**](/previous-versions/windows/desktop/secrcw32prov/win32-accountsid) | Association class
Relates a security account instance with a security descriptor instance.
| +//! | [**`Win32\_ACE**](/previous-versions/windows/desktop/secrcw32prov/win32-ace) | Instance class
Represents an access control entry (ACE).
| +//! | [**`Win32\_LogicalFileAccess**](/previous-versions/windows/desktop/secrcw32prov/win32-logicalfileaccess) | Association class
Relates the security settings of a file or directory and one member of its discretionary access control list (DACL).
| +//! | [**`Win32\_LogicalFileAuditing**](/previous-versions/windows/desktop/secrcw32prov/win32-logicalfileauditing) | Association class
Relates the security settings of a file or directory one member of its system access control list (SACL).
| +//! | [**`Win32\_LogicalFileGroup**](/previous-versions/windows/desktop/secrcw32prov/win32-logicalfilegroup) | Association class
Relates the security settings of a file or directory and its group.
| +//! | [**`Win32\_LogicalFileOwner**](/previous-versions/windows/desktop/secrcw32prov/win32-logicalfileowner) | Association class
Relates the security settings of a file or directory and its owner.
| +//! | [**`Win32\_LogicalFileSecuritySetting**](/previous-versions/windows/desktop/secrcw32prov/win32-logicalfilesecuritysetting) | Instance class
Represents security settings for a logical file.
| +//! | [**`Win32\_LogicalShareAccess**](/previous-versions/windows/desktop/secrcw32prov/win32-logicalshareaccess) | Association class
Relates the security settings of a share and one member of its DACL.
| +//! | [**`Win32\_LogicalShareAuditing**](/previous-versions/windows/desktop/secrcw32prov/win32-logicalshareauditing) | Association class
Relates the security settings of a share and one member of its SACL.
| +//! | [**`Win32\_LogicalShareSecuritySetting**](/previous-versions/windows/desktop/secrcw32prov/win32-logicalsharesecuritysetting) | Instance class
Represents security settings for a logical file.
| +//! | [**`Win32\_PrivilegesStatus**](win32-privilegesstatus) | Instance class
Represents information about the privileges required to complete an operation.
| +//! | [**`Win32\_SecurityDescriptor**](/previous-versions/windows/desktop/secrcw32prov/win32-securitydescriptor) | Instance class
Represents a structural representation of a [**`SECURITY\_DESCRIPTO`R**](/windows/desktop/api/winnt/ns-winnt-security_descriptor).
| +//! | [**`Win32\_SecuritySetting**](/previous-versions/windows/desktop/secrcw32prov/win32-securitysetting) | Instance class
Represents security settings for a managed element.
| +//! | [**`Win32\_SecuritySettingAccess**](/previous-versions/windows/desktop/secrcw32prov/win32-securitysettingaccess) | Instance class
Represents the rights granted and denied to a trustee for a given object.
| +//! | [**`Win32\_SecuritySettingAuditing**](/previous-versions/windows/desktop/secrcw32prov/win32-securitysettingauditing) | Instance class
Represents the auditing for a given trustee on a given object.
| +//! | [**`Win32\_SecuritySettingGroup**](/previous-versions/windows/desktop/secrcw32prov/win32-securitysettinggroup) | Association class
Relates the security of an object and its group.
| +//! | [**`Win32\_SecuritySettingOfLogicalFile**](/previous-versions/windows/desktop/secrcw32prov/win32-securitysettingoflogicalfile) | Instance class
Represents security settings of a file or directory object.
| +//! | [**`Win32\_SecuritySettingOfLogicalShare**](/previous-versions/windows/desktop/secrcw32prov/win32-securitysettingoflogicalshare) | Instance class
Represents security settings of a shared object.
| +//! | [**`Win32\_SecuritySettingOfObject**](/previous-versions/windows/desktop/secrcw32prov/win32-securitysettingofobject) | Association class
Relates an object to its security settings.
| +//! | [**`Win32\_SecuritySettingOwner**](/previous-versions/windows/desktop/secrcw32prov/win32-securitysettingowner) | Association class
Relates the security settings of an object and its owner.
| +//! | [**`Win32\_SID**](/previous-versions/windows/desktop/secrcw32prov/win32-sid) | Instance class
Represents an arbitrary SID.
| +//! | [**`Win32\_Trustee**](/previous-versions/windows/desktop/secrcw32prov/win32-trustee) | Instance class
Represents a trustee.
| use crate::update; use serde::{Deserialize, Serialize}; @@ -41,7 +41,7 @@ pub struct ACEs { update!(ACEs, aces); -/// Represents the state of Windows LogicalFileSecuritySettings +/// Represents the state of Windows `LogicalFileSecuritySettings` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct LogicalFileSecuritySettings { /// Represents sequence of Windows `LogicalFileSecuritySettings` @@ -52,7 +52,7 @@ pub struct LogicalFileSecuritySettings { update!(LogicalFileSecuritySettings, logical_file_security_settings); -/// Represents the state of Windows LogicalShareSecuritySettings +/// Represents the state of Windows `LogicalShareSecuritySettings` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct LogicalShareSecuritySettings { /// Represents sequence of Windows `LogicalShareSecuritySettings` @@ -63,7 +63,7 @@ pub struct LogicalShareSecuritySettings { update!(LogicalShareSecuritySettings, logical_share_security_settings); -/// Represents the state of Windows PrivilegesStatuses +/// Represents the state of Windows `PrivilegesStatuses` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct PrivilegesStatuses { /// Represents sequence of Windows `PrivilegesStatuses` @@ -74,7 +74,7 @@ pub struct PrivilegesStatuses { update!(PrivilegesStatuses, privileges_statuses); -/// Represents the state of Windows SecurityDescriptors +/// Represents the state of Windows `SecurityDescriptors` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct SecurityDescriptors { /// Represents sequence of Windows `SecurityDescriptors` @@ -85,7 +85,7 @@ pub struct SecurityDescriptors { update!(SecurityDescriptors, security_descriptors); -/// Represents the state of Windows SecuritySettings +/// Represents the state of Windows `SecuritySettings` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct SecuritySettings { /// Represents sequence of Windows `SecuritySettings` diff --git a/src/operating_system/shares.rs b/src/operating_system/shares.rs index bc77648..e86e35f 100644 --- a/src/operating_system/shares.rs +++ b/src/operating_system/shares.rs @@ -19,7 +19,7 @@ use serde::{Deserialize, Serialize}; use std::time::SystemTime; use wmi::{COMLibrary, WMIConnection, WMIDateTime}; -/// Represents the state of Windows ServerConnections +/// Represents the state of Windows `ServerConnections` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct ServerConnections { /// Represents sequence of Windows `ServerConnections` @@ -30,7 +30,7 @@ pub struct ServerConnections { update!(ServerConnections, server_connections); -/// Represents the state of Windows ServerSessions +/// Represents the state of Windows `ServerSessions` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct ServerSessions { /// Represents sequence of Windows `ServerSessions` @@ -41,7 +41,7 @@ pub struct ServerSessions { update!(ServerSessions, server_sessions); -/// Represents the state of Windows Shares +/// Represents the state of Windows `Shares` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct Shares { /// Represents sequence of Windows `Shares` diff --git a/src/operating_system/software_license_provider.rs b/src/operating_system/software_license_provider.rs index 43c1956..6af5175 100644 --- a/src/operating_system/software_license_provider.rs +++ b/src/operating_system/software_license_provider.rs @@ -11,7 +11,7 @@ use serde::{Deserialize, Serialize}; use std::time::SystemTime; use wmi::{COMLibrary, WMIConnection, WMIDateTime}; -/// Represents the state of Windows SoftwareLicensingProducts +/// Represents the state of Windows `SoftwareLicensingProducts` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct SoftwareLicensingProducts { /// Represents data stored in a Windows SoftwareLicensingProducts @@ -22,7 +22,7 @@ pub struct SoftwareLicensingProducts { update!(SoftwareLicensingProducts, software_licensing_products); -/// Represents the state of Windows SoftwareLicensingServices +/// Represents the state of Windows `SoftwareLicensingServices` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct SoftwareLicensingServices { /// Represents data stored in a Windows SoftwareLicensingServices @@ -33,7 +33,7 @@ pub struct SoftwareLicensingServices { update!(SoftwareLicensingServices, software_licensing_services); -/// Represents the state of Windows SoftwareLicensingTokenActivationLicenses +/// Represents the state of Windows `SoftwareLicensingTokenActivationLicenses` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct SoftwareLicensingTokenActivationLicenses { /// Represents data stored in a Windows SoftwareLicensingTokenActivationLicenses diff --git a/src/operating_system/start_menu.rs b/src/operating_system/start_menu.rs index afe9998..64cd2eb 100644 --- a/src/operating_system/start_menu.rs +++ b/src/operating_system/start_menu.rs @@ -14,7 +14,7 @@ use serde::{Deserialize, Serialize}; use std::time::SystemTime; use wmi::{COMLibrary, WMIConnection, WMIDateTime}; -/// Represents the state of Windows LogicalProgramGroups +/// Represents the state of Windows `LogicalProgramGroups` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct LogicalProgramGroups { /// Represents sequence of Windows `LogicalProgramGroups` @@ -25,7 +25,7 @@ pub struct LogicalProgramGroups { update!(LogicalProgramGroups, logical_program_groups); -/// Represents the state of Windows LogicalProgramGroupItems +/// Represents the state of Windows `LogicalProgramGroupItems` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct LogicalProgramGroupItems { /// Represents sequence of Windows `LogicalProgramGroupItems` @@ -36,7 +36,7 @@ pub struct LogicalProgramGroupItems { update!(LogicalProgramGroupItems, logical_program_group_items); -/// Represents the state of Windows ProgramGroupOrItems +/// Represents the state of Windows `ProgramGroupOrItems` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct ProgramGroupOrItems { /// Represents sequence of Windows `ProgramGroupOrItems` diff --git a/src/operating_system/storage.rs b/src/operating_system/storage.rs index 464b118..5d19328 100644 --- a/src/operating_system/storage.rs +++ b/src/operating_system/storage.rs @@ -19,7 +19,7 @@ use serde::{Deserialize, Serialize}; use std::time::SystemTime; use wmi::{COMLibrary, WMIConnection, WMIDateTime}; -/// Represents the state of Windows ShadowCopys +/// Represents the state of Windows `ShadowCopys` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct ShadowCopys { /// Represents sequence of `ShadowCopys` @@ -30,7 +30,7 @@ pub struct ShadowCopys { update!(ShadowCopys, shadow_copys); -/// Represents the state of Windows Volumes +/// Represents the state of Windows `Volumes` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct Volumes { /// Represents sequence of `Volumes` @@ -41,7 +41,7 @@ pub struct Volumes { update!(Volumes, volumes); -/// Represents the state of Windows ShadowContexts +/// Represents the state of Windows `ShadowContexts` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct ShadowContexts { /// Represents sequence of `ShadowContexts` @@ -52,7 +52,7 @@ pub struct ShadowContexts { update!(ShadowContexts, shadow_contexts); -/// Represents the state of Windows ShadowProviders +/// Represents the state of Windows `ShadowProviders` #[derive(Deserialize, Serialize, Debug, Clone)] pub struct ShadowProviders { /// Represents sequence of `ShadowProviders` diff --git a/src/operating_system/users.rs b/src/operating_system/users.rs index 8c56faf..6839113 100644 --- a/src/operating_system/users.rs +++ b/src/operating_system/users.rs @@ -87,8 +87,8 @@ update!(SystemAccounts, system_accounts); /// The `Win32_UserAccount` WMI class contains information about a user account on a computer system /// running Windows. /// -/// Note: Because both the Name and Domain are key properties, enumerating Win32_UserAccount on a -/// large network can negatively affect performance. Calling GetObject or querying for a specific +/// Note: Because both the Name and Domain are key properties, enumerating `Win32_UserAccount` on a +/// large network can negatively affect performance. Calling `GetObject` or querying for a specific /// instance has less impact. /// ///