Struct Contract 

pub struct Contract {
    pub dir: String,
    pub type_path: String,
    pub require_fields: bool,
    pub exclude: Vec<String>,
    pub module: Option<String>,
}

Fields

dir: String

Directory relative to htl.toml, e.g. "mods". One path segment may be * ("sites/*"): every subdirectory at that level is a contract directory.

type_path: String

"<module>.<Type>", e.g. "defs.Mod".

require_fields: bool

Every declared field must appear in the module’s returned table literal.

exclude: Vec<String>

Module names (file stems) inside dir that are not held to the contract, e.g. an SDK the host writes there (defs, modkit). The module that declares type is always exempt.

module: Option<String>

When set, only this module name (in each matched dir) is held to the contract.

Implementations

impl Contract

pub fn dirs(&self, root: &Path) -> Vec<PathBuf>

Concrete contract directories under root (expands one * segment). Missing directories are dropped; a literal dir that does not exist yields nothing.

pub fn applies_to(&self, module: &str) -> bool

Is a module with this name (file stem) held to the contract?

Trait Implementations

impl Clone for Contract

fn clone(&self) -> Contract

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Contract

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Contract

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.