Struct Declaration 

pub struct Declaration {
    pub version: u64,
    pub in: Vec<String>,
    pub out: Out,
}

scope.yaml, typed. Unknown keys are refused by the type and by the scope schema.

Fields

version: u64

The format version; only SCOPE_VERSION is read.

in: Vec<String>

The allow-list: pathspecs anchored at the repository root.

out: Out

What is never read; wins over in.

Implementations

impl Declaration

pub fn parse(path: &Path, text: &str) -> Result<Self, Error>

Parse and validate the text of a scope.yaml: the version, and every pattern well-formed (no leading slash, no :( prefix, no .. segment, a name pattern with no slash).

use majordomus_cli::scope::Declaration;
use std::path::Path;
let text = "version: 1\nin:\n  - src/**\nout:\n  paths: ['.git/']\n";
let d = Declaration::parse(Path::new("scope.yaml"), text).unwrap();
assert_eq!(d.r#in, vec!["src/**"]);
assert!(Declaration::parse(Path::new("s"), &text.replace("version: 1", "version: 2")).is_err());
assert!(Declaration::parse(Path::new("s"), &text.replace("src/**", "/src/**")).is_err());

Trait Implementations

impl Clone for Declaration

fn clone(&self) -> Declaration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Declaration

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Declaration

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Declaration

impl JsonSchema for Declaration

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for Declaration

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Declaration

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 Declaration