Struct Corpus 

pub struct Corpus {
    pub populated_doc_roots: Vec<String>,
    pub documents: Vec<TargetPath>,
    pub spec_shaped: Vec<TargetPath>,
    pub spec_without_rule_id: Vec<TargetPath>,
    pub ordinal_named: Vec<TargetPath>,
    pub records_outside_decisions: Vec<TargetPath>,
    pub has_specs_directory: bool,
}

What the corpus looks like, as counts and paths a detector reads.

Fields

populated_doc_roots: Vec<String>

Documentation roots at the top level that hold anything.

documents: Vec<TargetPath>

Every durable document, relative to the target, sorted.

spec_shaped: Vec<TargetPath>

Documents shaped like a specification of this convention.

spec_without_rule_id: Vec<TargetPath>

Specification-shaped documents that define no rule identifier.

ordinal_named: Vec<TargetPath>

Documents named by their position rather than their subject.

records_outside_decisions: Vec<TargetPath>

Decision records outside a decisions directory.

has_specs_directory: bool

Whether a specifications directory exists under a documentation root.

Implementations

impl Corpus

pub const fn settled(&self) -> bool

Whether the target documents itself already.

Documents, not directories. A documentation root holding empty directories is a layout somebody started and not a corpus somebody wrote, and refusing to land beside it would refuse a repository that has written nothing.

Trait Implementations

impl Clone for Corpus

fn clone(&self) -> Corpus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Corpus

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

Formats the value using the given formatter.

impl Default for Corpus

fn default() -> Corpus

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Corpus

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Corpus

impl PartialEq for Corpus

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Corpus

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 Corpus