Struct Resolved 

pub struct Resolved {
    pub dir: String,
    pub type_path: String,
    pub require_fields: RequireFields,
    pub module: Option<String>,
    pub exclude: Vec<String>,
    pub dts: Option<String>,
    pub enforced_by: Option<String>,
    pub declared_in: PathBuf,
    pub declared_at: usize,
}

A contract as it applies: which directory, which type, which fields.

Fields

dir: String

Directory relative to the project root, * in one segment expanding to every subdirectory at that level ("sites/*").

type_path: String

"<module>.<Type>", e.g. "defs.Mod" — the module that declares the record and the path to it inside that module.

require_fields: RequireFields

The fields a module’s returned table must set, from ---@required.

module: Option<String>

Only this module name in each matched dir is held to the contract.

exclude: Vec<String>

Module names in the dir that are not held to the contract.

dts: Option<String>

Where to publish the declaration, from ---@contract(dts = "…").

enforced_by: Option<String>

Where this contract is enforced when the scan cannot see it, from [[contract]] enforced_by. Not a marker argument: enforcement is the host’s business, and the record is published to authors who have no use for the path.

declared_in: PathBuf

The file the marker is in, and the line it is on: where to point when something about this contract is wrong.

declared_at: usize

Implementations

impl Resolved

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 module (a file stem under a contract dir) held to this contract? The module that declares the type is not held to it.

Trait Implementations

impl Clone for Resolved

fn clone(&self) -> Resolved

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Resolved

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

Formats the value using the given formatter.

impl Eq for Resolved

impl PartialEq for Resolved

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Resolved