Struct KernelMetadata 

#[non_exhaustive]
pub struct KernelMetadata {
    pub version: Option<String>,
    pub source: KernelSource,
    pub arch: String,
    pub image_name: String,
    pub config_hash: Option<String>,
    pub built_at: String,
    pub ktstr_kconfig_hash: Option<String>,
    pub extra_kconfig_hash: Option<String>,
    pub source_vmlinux_size: Option<u64>,
    pub source_vmlinux_mtime_secs: Option<i64>,
    /* private fields */
}

Metadata stored alongside a cached kernel image.

Required fields (source, arch, image_name, built_at, has_vmlinux, vmlinux_stripped) must be present in metadata.json during deserialization; a truncated file that drops any of them surfaces the entry as ListedEntry::Corrupt via crate::cache::CacheDir::list rather than silently defaulting. Optional fields tolerate absent keys as None.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

version: Option<String>

Kernel version string (e.g. “6.14.2”, “6.15-rc3”). None when no version could be established — a local or git source whose Makefile is unreadable/unparsable, or an acquisition path that records none.

source: KernelSource

How the kernel source was acquired, with per-source payload.

arch: String

Target architecture (e.g. “x86_64”, “aarch64”).

image_name: String

Boot image filename (e.g. “bzImage”, “Image”).

config_hash: Option<String>

CRC32 of the final .config used for the build.

built_at: String

ISO 8601 timestamp of when the image was built.

ktstr_kconfig_hash: Option<String>

CRC32 of ktstr.kconfig at build time.

extra_kconfig_hash: Option<String>

CRC32 of the user-supplied --extra-kconfig fragment (raw bytes) at build time. None for builds without --extra-kconfig.

source_vmlinux_size: Option<u64>

Size in bytes of the SOURCE-TREE vmlinux at cache-store time.

source_vmlinux_mtime_secs: Option<i64>

Modification time (seconds since UNIX epoch) of the SOURCE-TREE vmlinux at cache-store time.

Implementations

impl KernelMetadata

pub fn new( source: KernelSource, arch: impl Into<String>, image_name: impl Into<String>, built_at: impl Into<String>, ) -> Self

Create a new KernelMetadata with required fields.

pub fn with_source_vmlinux_stat(self, size: u64, mtime_secs: i64) -> Self

Set the source-tree vmlinux size and mtime captured at cache store time.

pub fn clear_source_vmlinux_stat(self) -> Self

Unset the source-tree vmlinux stat (both size and mtime back to the None default).

pub fn with_version(self, version: impl Into<String>) -> Self

Set the kernel version.

pub fn clear_version(self) -> Self

Unset the kernel version (back to the None default).

pub fn with_config_hash(self, hash: impl Into<String>) -> Self

Set the .config CRC32 hash.

pub fn clear_config_hash(self) -> Self

Unset the .config CRC32 hash (back to the None default).

pub fn with_ktstr_kconfig_hash(self, hash: impl Into<String>) -> Self

Set the ktstr.kconfig CRC32 hash.

pub fn clear_ktstr_kconfig_hash(self) -> Self

Unset the ktstr.kconfig CRC32 hash (back to the None default).

pub fn with_extra_kconfig_hash(self, hash: impl Into<String>) -> Self

Set the --extra-kconfig fragment CRC32 hash.

pub fn clear_extra_kconfig_hash(self) -> Self

Unset the --extra-kconfig fragment CRC32 hash (back to the None default).

pub fn has_vmlinux(&self) -> bool

Whether a vmlinux ELF was cached alongside the image.

pub fn vmlinux_stripped(&self) -> bool

Whether the cached vmlinux came from a successful strip pass.

Trait Implementations

impl Clone for KernelMetadata

fn clone(&self) -> KernelMetadata

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for KernelMetadata

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KernelMetadata

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for KernelMetadata

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.