docs: add warnings to ABI-incompatible enums

Author: mkroening

src/lib.rs

@@ -163,6 +163,15 @@ virtio_bitflags! {
 }
 
 /// Virtio Device IDs
+///
+/// <div class="warning">
+///
+/// This enum is not ABI-compatible with it's corresponding field.
+/// Use [`Id::from`] for converting from an integer.
+///
+/// </div>
+///
+/// [`Id::from`]: Id#impl-From<u8>-for-Id
 #[derive(IntoPrimitive, FromPrimitive, PartialEq, Eq, Clone, Copy, Debug)]
 #[non_exhaustive]
 #[repr(u8)]

src/net.rs

@@ -78,6 +78,15 @@ virtio_bitflags! {
 }
 
 /// Network Device Header GSO Type
+///
+/// <div class="warning">
+///
+/// This enum is not ABI-compatible with it's corresponding field.
+/// Use [`HdrGso::from`] for converting from an integer.
+///
+/// </div>
+///
+/// [`HdrGso::from`]: HdrGso#impl-From<u8>-for-HdrGso
 #[doc(alias = "VIRTIO_NET_HDR_GSO")]
 #[derive(IntoPrimitive, FromPrimitive, PartialEq, Eq, Clone, Copy, Debug)]
 #[non_exhaustive]
@@ -186,6 +195,15 @@ endian_bitflags! {
 }
 
 /// Hash Report
+///
+/// <div class="warning">
+///
+/// This enum is not ABI-compatible with it's corresponding field.
+/// Use [`HashReport::from`] for converting from an integer.
+///
+/// </div>
+///
+/// [`HashReport::from`]: HashReport#impl-From<u16>-for-HashReport
 #[doc(alias = "VIRTIO_NET_HASH_REPORT")]
 #[derive(IntoPrimitive, FromPrimitive, PartialEq, Eq, Clone, Copy, Debug)]
 #[non_exhaustive]

src/pci.rs

@@ -270,6 +270,15 @@ impl CapData {
 }
 
 /// PCI Capability Configuration Type
+///
+/// <div class="warning">
+///
+/// This enum is not ABI-compatible with it's corresponding field.
+/// Use [`CapCfgType::from`] for converting from an integer.
+///
+/// </div>
+///
+/// [`CapCfgType::from`]: CapCfgType#impl-From<u8>-for-CapCfgType
 #[doc(alias = "VIRTIO_PCI_CAP")]
 #[derive(IntoPrimitive, FromPrimitive, PartialEq, Eq, Clone, Copy, Debug)]
 #[non_exhaustive]