Struct CheckMetadata 

pub struct CheckMetadata {

    pub name: Option<String>,
    pub description: Option<String>,
    pub impact: Option<String>,
    pub severity: Option<Severity>,
    pub author: Option<String>,
    pub cve: Vec<String>,
    pub cwe: Vec<String>,
    pub references: Vec<String>,
    pub cvss: Vec<String>,
    pub cvss_score: Vec<String>,
    pub mitigation: Option<String>,
    pub tags: Vec<String>,
    pub version: Option<String>,
    pub family: Option<String>,
}

The metadata { … } block of a check — describes the finding it emits.

Only name is required to emit a finding; the rest enriches the report and is needed to publish to the registry.

Fields

name: Option<String>

Short finding title (the registry slug derives from this).

description: Option<String>

What the check does.

impact: Option<String>

The risk if the check is positive.

severity: Option<Severity>

Finding severity (defaults to Info when unset).

author: Option<String>

Check author.

cve: Vec<String>

Associated CVE identifiers.

cwe: Vec<String>

Associated CWE identifiers.

references: Vec<String>

Reference URLs (advisories, docs).

cvss: Vec<String>

CVSS vector strings (e.g. base + temporal).

cvss_score: Vec<String>

CVSS numeric scores.

mitigation: Option<String>

Single free-text remediation note. The language rejects more than one mitigation line per script at compile time (unlike cve/cwe/ references/tags, which accumulate into lists).

tags: Vec<String>

Free-form discovery labels (many per check).

version: Option<String>

SemVer string; required at publish time, optional for local use.

family: Option<String>

Single curated category (e.g. web, network, database). Distinct from tags: one-per-script, used for “scan everything in this family” selection. The allowed set is enforced by the registry at publish time, not here.

Trait Implementations

impl Clone for CheckMetadata

fn clone(&self) -> CheckMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CheckMetadata

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

Formats the value using the given formatter.

impl Default for CheckMetadata

fn default() -> CheckMetadata

Returns the “default value” for a type.