doc: add example use uefi::table::cfg::ConfigTableEntry

Author: fox0

uefi/src/system.rs

@@ -51,6 +51,23 @@ pub fn uefi_revision() -> Revision {
 
 /// Call `f` with a slice of [`ConfigTableEntry`]. Each entry provides access to
 /// a vendor-specific table.
+///
+/// # Example
+///
+/// ```rust,no_run
+/// use uefi::system::with_config_table;
+/// use uefi::table::cfg::ConfigTableEntry;
+///
+/// with_config_table(|slice| {
+///     for i in slice {
+///         match i.guid {
+///             ConfigTableEntry::ACPI_GUID => println!("ACPI"),
+///             ConfigTableEntry::ACPI2_GUID => println!("ACPI2"),
+///             guid => println!("GUID: {}", guid),
+///         }
+///     }
+/// });
+/// ```
 pub fn with_config_table<F, R>(f: F) -> R
 where
     F: Fn(&[ConfigTableEntry]) -> R,

uefi/src/table/cfg.rs

@@ -8,6 +8,8 @@
 //!
 //! This module contains the actual entries of the configuration table,
 //! as well as GUIDs for many known vendor tables.
+//! 
+//! https://uefi.org/specs/UEFI/2.10/04_EFI_System_Table.html#efi-configuration-table-properties-table
 
 use crate::{guid, Guid};
 use bitflags::bitflags;
@@ -16,6 +18,8 @@ use core::ffi::c_void;
 /// Contains a set of GUID / pointer for a vendor-specific table.
 ///
 /// The UEFI standard guarantees each entry is unique.
+/// 
+/// https://uefi.org/specs/UEFI/2.10/04_EFI_System_Table.html#efi-configuration-table
 #[derive(Clone, Debug, Eq, PartialEq, Ord, PartialOrd, Hash)]
 #[repr(C)]
 pub struct ConfigTableEntry {