Struct InstanceConfig 

pub struct InstanceConfig {
    pub reserved: Vec<String>,
    pub gates: BTreeMap<String, GateFilters>,
    pub writing_style: WritingStyle,
}

The declaration as written.

Fields

reserved: Vec<String>

Paths no delivered gate judges. Another tool owns these.

gates: BTreeMap<String, GateFilters>

Per-gate filters, keyed by gate id. A gate not named here takes its registry default.

writing_style: WritingStyle

Where the writing style comes from. Absent, the convention’s own chapter.

Implementations

impl InstanceConfig

pub fn parse(text: &str) -> Result<Self, ConfigError>

Parse a declaration.

Errors

ConfigError::Shape when the text is not a declaration, and ConfigError::UnknownGate when a gates: key names no delivered gate. Neither falls back to the default: a filter that quietly stops applying is worse than one that fails loudly.

pub fn read(repo_root: &Utf8Path) -> Result<Self, ConfigError>

Read the declaration an instance carries.

A missing file is the empty declaration and never an error: an instance that declares nothing is a valid instance.

Errors

See Self::parse. An unreadable file that exists is a shape error rather than a silent default.

pub fn for_gate(&self, id: GateId) -> Option<&GateFilters>

This gate’s declared filters, if the project named it.

Trait Implementations

impl Clone for InstanceConfig

fn clone(&self) -> InstanceConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InstanceConfig

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

Formats the value using the given formatter.

impl Default for InstanceConfig

fn default() -> InstanceConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for InstanceConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for InstanceConfig

impl PartialEq for InstanceConfig

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for InstanceConfig