Struct PkgEntity 

pub struct PkgEntity {
    pub name: String,
    pub version: Option<String>,
    pub description: Option<String>,
    pub category: Option<String>,
    pub docstring: Option<String>,
    pub tags: Option<Vec<String>>,
    pub pkg_type: Option<PkgType>,
    pub type_source: Option<TypeSource>,
}

Canonical projection of a Lua package’s M.meta block.

name is required (= hub-index inclusion gate). Other fields are optional and degrade UI / discoverability when absent, following the BP convention of Cargo / JSR / npm.

Fields

name: String

version: Option<String>

description: Option<String>

category: Option<String>

docstring: Option<String>

tags: Option<Vec<String>>

pkg_type: Option<PkgType>

Package type ("runnable" or "library"). Serialized as "type" on the wire. None means the type was not determined (legacy entries).

type_source: Option<TypeSource>

Records how pkg_type was determined. None for legacy entries that pre-date provenance tracking (#[serde(default)] ensures backward compatibility with existing hub_index.json consumers).

Uses a lenient deserializer so that legacy JSON with "type_source": "explicit" (a v0.40.0-only addition now removed) degrades to None instead of erroring.

Implementations

impl PkgEntity

pub fn parse_from_init_lua(path: &Path) -> Option<Self>

Parse M.meta + leading --- docstring from an init.lua.

Returns None when the file cannot be read, M.meta is absent, or M.meta.name is empty. Callers treat None as “not a package” and drop the directory silently from the hub index.

The parser is not a full Lua evaluator:

• Only flat key–value pairs inside M.meta are extracted.
• Nested tables (e.g. tags = { ... }) are skipped via brace-depth tracking; their keys are not reachable from here.
• Values must be string literals ("..."), optionally joined by .. concatenation with whitespace between operators.
• Occurrences of M.meta inside single-line comments (-- ...) are ignored, so docstrings mentioning the key do not hijack the search.

Trait Implementations

impl Clone for PkgEntity

fn clone(&self) -> PkgEntity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PkgEntity

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

Formats the value using the given formatter.

impl Default for PkgEntity

fn default() -> PkgEntity

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PkgEntity

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for PkgEntity

impl PartialEq for PkgEntity

fn eq(&self, other: &PkgEntity) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for PkgEntity

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PkgEntity