Struct Config 

pub struct Config {
    pub docs: Vec<String>,
    pub requirements: Vec<String>,
    pub tests: Vec<String>,
    pub diff_base: String,
    pub judge: JudgeConfig,
    pub rust: RustConfig,
    pub exclude: Vec<String>,
    pub index: Vec<String>,
    pub site: Option<SiteConfig>,
}

Fields

docs: Vec<String>

requirements: Vec<String>

tests: Vec<String>

diff_base: String

judge: JudgeConfig

rust: RustConfig

exclude: Vec<String>

index: Vec<String>

Index roots (directories whose index.md lists the documents below).

site: Option<SiteConfig>

Settings for miwa site.

Implementations

impl Config

pub fn default_config() -> Config

docs=[“docs”], requirements=[“req”], tests=[“.”], diff_base=“main”

pub fn parse(yaml: &str) -> Result<Config>

Parse yaml into a Config and validate it.

pub fn to_yaml(&self) -> String

pub fn validate(&self) -> Result<()>

index rules: each entry must be non-empty after normalization, equal to or under a docs / requirements entry, not contain an excluded directory name (exclude or the default exclusions) as a segment, and no two entries may be equal or nested in each other.

threshold must be finite and within 0..=1; each Vec must be non-empty; diff_base must be non-empty; each rust.test_attributes entry must be a non-empty [A-Za-z0-9_]+ string; each exclude entry must be a bare directory name (no whitespace, separators, globs, ./..); and no docs/requirements/tests entry may lie under an excluded directory (exclude or the default exclusions).

Trait Implementations

impl Clone for Config

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Config

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Config

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Config

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 Config