Struct ModuleMetadata 

#[non_exhaustive]
pub struct ModuleMetadata {
    pub module_name: String,
    pub description: String,
    pub keywords: Vec<String>,
    pub env_vars: Vec<String>,
    pub icon: Option<String>,
    pub category: Option<String>,
    pub quickrefs: Vec<QuickRef>,
    pub auto_functions: Vec<String>,
}

LDoc-style metadata parsed from --- @tag value lines at the top of a Lua module.

Only assay constructs one; #[non_exhaustive] keeps a new @tag a patch release instead of forcing a minor on every consumer.

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.

module_name: String

From @module tag

description: String

From @description tag

keywords: Vec<String>

From @keywords tag, split by comma and trimmed

env_vars: Vec<String>

From @env tag, split by comma and trimmed

icon: Option<String>

From @icon tag — a simple-icons slug, absent when no brand fits

category: Option<String>

From @category tag

quickrefs: Vec<QuickRef>

From @quickref tags (one per tag line)

auto_functions: Vec<String>

Auto-extracted function names from function c:method( and function M.method( patterns

Trait Implementations

impl Clone for ModuleMetadata

fn clone(&self) -> ModuleMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModuleMetadata

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

Formats the value using the given formatter.

impl Default for ModuleMetadata

fn default() -> ModuleMetadata

Returns the “default value” for a type.