Convert all allow(missing_docs) to expects (#533)

Working towards #300 and #287

Author: smalis-msft

openhcl/hcl/src/ioctl.rs

@@ -83,7 +83,7 @@ use zerocopy::FromZeroes;
 
 /// Error returned by HCL operations.
 #[derive(Error, Debug)]
-#[allow(missing_docs)]
+#[expect(missing_docs)]
 pub enum Error {
     #[error("failed to open mshv device")]
     OpenMshv(#[source] io::Error),
@@ -151,7 +151,7 @@ pub struct IoctlError(#[source] pub(crate) nix::Error);
 
 /// Error returned when issuing hypercalls.
 #[derive(Debug, Error)]
-#[allow(missing_docs)]
+#[expect(missing_docs)]
 pub enum HypercallError {
     #[error("hypercall failed with {0:?}")]
     Hypervisor(HvError),
@@ -173,7 +173,7 @@ impl HypercallError {
 
 /// Errors when issuing hypercalls via the kernel direct interface.
 #[derive(Error, Debug)]
-#[allow(missing_docs)]
+#[expect(missing_docs)]
 pub enum HvcallError {
     #[error("kernel rejected the hypercall, most likely due to the hypercall code not being allowed via set_allowed_hypercalls")]
     HypercallIoctlFailed(#[source] nix::Error),
@@ -188,7 +188,7 @@ pub enum HvcallError {
 /// Error applying VTL protections.
 // TODO: move to `underhill_mem`.
 #[derive(Error, Debug)]
-#[allow(missing_docs)]
+#[expect(missing_docs)]
 pub enum ApplyVtlProtectionsError {
     #[error(
         "hypervisor returned {output:?} error {hv_error:?} when protecting pages {range} for vtl {vtl:?}"
@@ -223,7 +223,7 @@ pub enum ApplyVtlProtectionsError {
 
 /// Error setting guest VSM configuration.
 #[derive(Error, Debug)]
-#[allow(missing_docs)]
+#[expect(missing_docs)]
 pub enum SetGuestVsmConfigError {
     #[error(
         "hypervisor returned error {hv_error:?} when configuring guest vsm {enable_guest_vsm:?}"
@@ -236,15 +236,15 @@ pub enum SetGuestVsmConfigError {
 
 /// Error getting the VP idnex from an APIC ID.
 #[derive(Error, Debug)]
-#[allow(missing_docs)]
+#[expect(missing_docs)]
 pub enum GetVpIndexFromApicIdError {
     #[error("hypervisor returned error {hv_error:?} when querying vp index for {apic_id}")]
     Hypervisor { hv_error: HvError, apic_id: u32 },
 }
 
 /// Error setting VSM partition configuration.
 #[derive(Error, Debug)]
-#[allow(missing_docs)]
+#[expect(missing_docs)]
 pub enum SetVsmPartitionConfigError {
     #[error(
         "hypervisor returned error {hv_error:?} when configuring vsm partition config {config:?}"
@@ -257,7 +257,7 @@ pub enum SetVsmPartitionConfigError {
 
 /// Error translating a GVA to a GPA.
 #[derive(Error, Debug)]
-#[allow(missing_docs)]
+#[expect(missing_docs)]
 pub enum TranslateGvaToGpaError {
     #[error("hypervisor returned error {hv_error:?} on gva {gva:x}")]
     Hypervisor { gva: u64, hv_error: HvError },
@@ -281,7 +281,7 @@ pub struct CheckVtlAccessResult {
 /// Error accepting pages.
 // TODO: move to `underhill_mem`.
 #[derive(Error, Debug)]
-#[allow(missing_docs)]
+#[expect(missing_docs)]
 pub enum AcceptPagesError {
     #[error("hypervisor returned {output:?} error {hv_error:?} when accepting pages {range}")]
     Hypervisor {

openhcl/hcl/src/ioctl/snp.rs

@@ -34,7 +34,7 @@ pub struct Snp {
 
 /// Error returned by failing SNP operations.
 #[derive(Debug, Error)]
-#[allow(missing_docs)]
+#[expect(missing_docs)]
 pub enum SnpError {
     #[error("operating system error")]
     Os(#[source] nix::Error),
@@ -44,7 +44,7 @@ pub enum SnpError {
 
 /// Error returned by failing SNP page operations.
 #[derive(Debug, Error)]
-#[allow(missing_docs)]
+#[expect(missing_docs)]
 pub enum SnpPageError {
     #[error("pvalidate failed")]
     Pvalidate(#[source] SnpError),

openhcl/hcl/src/ioctl/x64.rs

@@ -37,7 +37,7 @@ pub struct TranslateErrorX64 {
 
 /// Result when the intercepted vtl is invalid.
 #[derive(Error, Debug)]
-#[allow(missing_docs)]
+#[expect(missing_docs)]
 pub enum RegisterPageVtlError {
     #[error("no register page")]
     NoRegisterPage,

openhcl/hcl/src/stats.rs

@@ -9,7 +9,7 @@ use thiserror::Error;
 
 /// Error returned by [`vp_stats`].
 #[derive(Debug, Error)]
-#[allow(missing_docs)]
+#[expect(missing_docs)]
 pub enum VpStatsError {
     #[error("failed to read /proc/mshv")]
     Read(#[source] std::io::Error),

openhcl/underhill_attestation/src/crypto.rs

@@ -10,14 +10,12 @@ use openssl::rsa::Rsa;
 use openssl_kdf::kdf::Kbkdf;
 use thiserror::Error;
 
-#[allow(missing_docs)] // self-explanatory fields
 #[derive(Debug, Error)]
 pub(crate) enum KbkdfError {
     #[error("KDF derivation failed")]
     Derive(#[from] openssl_kdf::kdf::KdfError),
 }
 
-#[allow(missing_docs)] // self-explanatory fields
 #[derive(Debug, Error)]
 pub(crate) enum Pkcs11RsaAesKeyUnwrapError {
     #[error("expected wrapped AES key blob to be {0} bytes, but found {1} bytes")]
@@ -34,7 +32,6 @@ pub(crate) enum Pkcs11RsaAesKeyUnwrapError {
     PkeyToRsa(#[from] openssl::error::ErrorStack),
 }
 
-#[allow(missing_docs)] // self-explanatory fields
 #[derive(Debug, Error)]
 pub(crate) enum RsaOaepError {
     #[error("failed to convert an RSA key to PKey")]
@@ -55,7 +52,6 @@ pub(crate) enum RsaOaepError {
     Decrypt(#[source] openssl::error::ErrorStack, RsaOaepHashAlgorithm),
 }
 
-#[allow(missing_docs)] // self-explanatory fields
 #[derive(Debug, Error)]
 pub(crate) enum AesKeyWrapWithPaddingError {
     #[error("invalid wrapping key size {0}")]
@@ -74,7 +70,6 @@ pub(crate) enum AesKeyWrapWithPaddingError {
     UnwrapUpdate(#[source] openssl::error::ErrorStack),
 }
 
-#[allow(missing_docs)] // self-explanatory fields
 #[derive(Debug, Error)]
 pub(crate) enum Aes256CbcError {
     #[error("CipherCtx::new failed")]
@@ -89,7 +84,6 @@ pub(crate) enum Aes256CbcError {
     Decrypt(#[source] openssl::error::ErrorStack),
 }
 
-#[allow(missing_docs)] // self-explanatory fields
 #[derive(Debug, Error)]
 pub(crate) enum HmacSha256Error {
     #[error("failed to convert an HMAC key to PKey")]

openhcl/underhill_attestation/src/hardware_key_sealing.rs

@@ -14,7 +14,6 @@ use openssl_kdf::kdf::Kbkdf;
 use thiserror::Error;
 use zerocopy::AsBytes;
 
-#[allow(missing_docs)] // self-explanatory fields
 #[derive(Debug, Error)]
 pub(crate) enum HardwareDerivedKeysError {
     #[error("failed to initialize hardware secret")]
@@ -23,7 +22,6 @@ pub(crate) enum HardwareDerivedKeysError {
     KdfWithHardwareSecret(#[source] openssl_kdf::kdf::KdfError),
 }
 
-#[allow(missing_docs)] // self-explanatory fields
 #[derive(Debug, Error)]
 pub(crate) enum HardwareKeySealingError {
     #[error("failed to encrypt the egress key")]

openhcl/underhill_attestation/src/igvm_attest/key_release.rs

@@ -13,11 +13,9 @@ use openssl::rsa::Padding;
 use openssl::sign::Verifier;
 use openssl::x509::X509VerifyResult;
 use openssl::x509::X509;
-use thiserror::Error;
-
 use std::fmt::Write;
+use thiserror::Error;
 
-#[allow(missing_docs)] // self-explanatory fields
 #[derive(Debug, Error)]
 pub(crate) enum KeyReleaseError {
     #[error("the response size is too small to parse")]
@@ -32,7 +30,6 @@ pub(crate) enum KeyReleaseError {
     GetWrappedKeyFromAkvJwtBody(#[source] AkvKeyReleaseJwtError),
 }
 
-#[allow(missing_docs)] // self-explanatory fields
 #[derive(Debug, Error)]
 pub(crate) enum AkvKeyReleaseJwtError {
     #[error("JWT data is not valid UTF-8: {0}")]
@@ -65,7 +62,6 @@ pub(crate) enum AkvKeyReleaseJwtError {
     KeyHsmBlobToJson(#[source] serde_json::Error),
 }
 
-#[allow(missing_docs)] // self-explanatory fields
 #[derive(Debug, Error)]
 pub(crate) enum JwtSignatureVerificationError {
     #[error("invalid key type {key_type:?}, expected {expected_type:?}")]
@@ -85,7 +81,6 @@ pub(crate) enum JwtSignatureVerificationError {
     UnsupportedSigningAlgorithm(String),
 }
 
-#[allow(missing_docs)] // self-explanatory fields
 #[derive(Debug, Error)]
 pub(crate) enum CertificateChainValidationError {
     #[error("certificate chain is empty")]

openhcl/underhill_attestation/src/igvm_attest/mod.rs

@@ -21,7 +21,7 @@ pub mod wrapped_key;
 
 base64_serde_type!(Base64Url, base64::engine::general_purpose::URL_SAFE_NO_PAD);
 
-#[allow(missing_docs)] // self-explanatory fields
+#[expect(missing_docs)] // self-explanatory fields
 #[derive(Debug, Error)]
 pub enum Error {
     #[error(

openhcl/underhill_attestation/src/igvm_attest/wrapped_key.rs

@@ -7,7 +7,6 @@
 use openhcl_attestation_protocol::igvm_attest::cps;
 use thiserror::Error;
 
-#[allow(missing_docs)] // self-explanatory fields
 #[derive(Debug, Error)]
 pub(crate) enum WrappedKeyError {
     #[error("failed to deserialize the response payload into JSON: {json_data}")]

openhcl/underhill_attestation/src/key_protector.rs

@@ -13,7 +13,6 @@ use openssl::pkey::Private;
 use openssl::rsa::Rsa;
 use thiserror::Error;
 
-#[allow(missing_docs)] // self-explanatory fields
 #[derive(Debug, Error)]
 pub(crate) enum GetKeysFromKeyProtectorError {
     #[error(

openhcl/underhill_attestation/src/lib.rs

@@ -79,7 +79,6 @@ enum AttestationErrorInner {
     ReadGuestSecretKey(#[source] vmgs::ReadFromVmgsError),
 }
 
-#[allow(missing_docs)] // self-explanatory fields
 #[derive(Debug, Error)]
 enum GetDerivedKeysError {
     #[error("failed to get ingress/egress keys from the the key protector")]
@@ -114,7 +113,6 @@ enum GetDerivedKeysError {
     DeriveEgressKey(#[source] crypto::KbkdfError),
 }
 
-#[allow(missing_docs)] // self-explanatory fields
 #[derive(Debug, Error)]
 enum GetDerivedKeysByIdError {
     #[error("failed to derive an egress key based on current vm bios guid")]
@@ -133,7 +131,6 @@ enum GetDerivedKeysByIdError {
     },
 }
 
-#[allow(missing_docs)] // self-explanatory fields
 #[derive(Debug, Error)]
 enum UnlockVmgsDataStoreError {
     #[error("failed to unlock vmgs with the new ingress key")]
@@ -154,7 +151,6 @@ enum UnlockVmgsDataStoreError {
     PersistAllKeyProtectors(#[source] PersistAllKeyProtectorsError),
 }
 
-#[allow(missing_docs)] // self-explanatory fields
 #[derive(Debug, Error)]
 enum PersistAllKeyProtectorsError {
     #[error("failed to write key protector to vmgs")]

openhcl/underhill_attestation/src/secure_key_release.rs

@@ -21,7 +21,6 @@ use thiserror::Error;
 use vmgs::EncryptionAlgorithm;
 use vmgs::Vmgs;
 
-#[allow(missing_docs)] // self-explanatory fields
 #[derive(Debug, Error)]
 pub(crate) enum RequestVmgsEncryptionKeysError {
     #[error("failed to generate an RSA transfer key")]

openhcl/underhill_attestation/src/vmgs.rs

@@ -18,7 +18,6 @@ use zerocopy::AsBytes;
 use zerocopy::FromBytes;
 use zerocopy::FromZeroes;
 
-#[allow(missing_docs)] // self-explanatory fields
 #[derive(Debug, Error)]
 pub(crate) enum ReadFromVmgsError {
     #[error("failed to read {file_id:?} from vmgs")]

openhcl/underhill_core/src/emuplat/tpm.rs

@@ -9,7 +9,6 @@ use thiserror::Error;
 use tpm::ak_cert::RequestAkCert;
 use underhill_attestation::AttestationType;
 
-#[allow(missing_docs)] // self-explanatory fields
 #[derive(Debug, Error)]
 pub enum TpmAttestationError {
     #[error("failed to get a hardware attestation report")]

openhcl/underhill_mem/src/init.rs

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-#![allow(missing_docs)]
+#![expect(missing_docs)]
 
 use crate::mapping::GuestMemoryMapping;
 use crate::mapping::HardwareIsolatedMemoryProtector;

openhcl/underhill_mem/src/lib.rs

@@ -58,7 +58,6 @@ mod mapping {
     use x86defs::tdx::TdgMemPageGpaAttr;
 
     /// Error querying vtl permissions on a page
-    #[allow(missing_docs)]
     #[derive(Debug, Error)]
     pub enum QueryVtlPermissionsError {
         #[error("failed to query rmp permissions")]
@@ -79,7 +78,6 @@ mod mapping {
     }
 
     /// Error constructing a [`GuestMemoryMapping`].
-    #[allow(missing_docs)]
     #[derive(Debug, Error)]
     pub enum MappingError {
         #[error("failed to allocate VA space for guest memory")]

openhcl/virt_mshv_vtl/src/lib.rs

@@ -113,7 +113,7 @@ use zerocopy::FromZeroes;
 
 /// General error returned by operations.
 #[derive(Error, Debug)]
-#[allow(missing_docs)]
+#[expect(missing_docs)]
 pub enum Error {
     #[error("hcl error")]
     Hcl(#[source] hcl::ioctl::Error),
@@ -158,7 +158,7 @@ pub enum Error {
 
 /// Error revoking guest VSM.
 #[derive(Error, Debug)]
-#[allow(missing_docs)]
+#[expect(missing_docs)]
 pub enum RevokeGuestVsmError {
     #[error("failed to set vsm config")]
     SetGuestVsmConfig(#[source] hcl::ioctl::SetGuestVsmConfigError),

petri/petri_artifacts_common/src/lib.rs

@@ -32,7 +32,7 @@ pub mod tags {
     /// A coarse-grained label used to differentiate between different OS
     /// environments.
     #[derive(Debug, Clone, Copy)]
-    #[allow(missing_docs)] // Self-describing names.
+    #[expect(missing_docs)] // Self-describing names.
     pub enum OsFlavor {
         Windows,
         Linux,
@@ -42,7 +42,7 @@ pub mod tags {
 
     /// The machine architecture supported by the artifact or VM.
     #[derive(Copy, Clone, Debug, PartialEq, Eq)]
-    #[allow(missing_docs)] // Self describing names
+    #[expect(missing_docs)] // Self describing names
     pub enum MachineArch {
         X86_64,
         Aarch64,

petri/src/lib.rs

@@ -34,7 +34,7 @@ pub const SIZE_1_MB: u64 = 1024 * SIZE_1_KB;
 pub const SIZE_1_GB: u64 = 1024 * SIZE_1_MB;
 
 /// The kind of shutdown to perform.
-#[allow(missing_docs)] // Self-describing names.
+#[expect(missing_docs)] // Self-describing names.
 pub enum ShutdownKind {
     Shutdown,
     Reboot,

support/guid/src/lib.rs

@@ -21,7 +21,7 @@ use zerocopy::FromZeroes;
     mesh(package = "msguid")
 )]
 #[cfg_attr(feature = "inspect", derive(inspect::Inspect), inspect(display))]
-#[allow(missing_docs)]
+#[expect(missing_docs)]
 pub struct Guid {
     #[cfg_attr(feature = "mesh", mesh(1))]
     pub data1: u32,
@@ -168,7 +168,7 @@ impl std::fmt::Debug for Guid {
 
 /// An error parsing a GUID.
 #[derive(Debug, Error)]
-#[allow(missing_docs)]
+#[expect(missing_docs)]
 pub enum ParseError {
     #[error("invalid GUID length")]
     Length,