Struct IntentPreflightInput 

pub struct IntentPreflightInput {
    pub issue: Option<String>,
    pub paths: String,
}

The work to preflight: an issue, or the paths it will touch.

paths is one comma-separated string rather than a list because a preflight changes nothing and is therefore a GET, and this repository binds a GET input to the query string.

use majordomus_cli::capability::builtin::intents::IntentPreflightInput;
// an issue, when the work executes one
let by_issue = IntentPreflightInput { issue: Some("I1900".into()), paths: String::new() };
assert!(by_issue.path_list().is_empty());
// or the paths it will touch, when it names no issue yet
let by_paths = IntentPreflightInput {
    issue: None,
    paths: "apps/majordomus-cli/src,docs".into(),
};
assert_eq!(by_paths.path_list(), ["apps/majordomus-cli/src", "docs"]);

Fields

issue: Option<String>

The issue the work executes, by id. When given, the paths are not consulted.

paths: String

Repository-relative paths the work will touch, separated by commas.

Implementations

impl IntentPreflightInput

pub fn path_list(&self) -> Vec<String>

The paths as a list: trimmed, with the empties a trailing or doubled comma leaves dropped, so a query string written by hand resolves the same way as one written by a program.

use majordomus_cli::capability::builtin::intents::IntentPreflightInput;
let i = IntentPreflightInput { issue: None, paths: " lib, ,docs/X.md".into() };
assert_eq!(i.path_list(), ["lib", "docs/X.md"]);

Trait Implementations

impl BenchmarkCases for IntentPreflightInput

fn benchmark_cases(ctx: &CaseContext<'_>) -> Vec<NamedCase<Self>>

The cases, in a stable order. An empty list means “nothing to benchmark in this repository”, which the coverage check reports as missing.

fn benchmark_cases_json(ctx: &CaseContext<'_>) -> Vec<NamedCase<Value>>

The cases as JSON, the shape every runner serialises from.

impl Clone for IntentPreflightInput

fn clone(&self) -> IntentPreflightInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IntentPreflightInput

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

Formats the value using the given formatter.

impl Default for IntentPreflightInput

fn default() -> IntentPreflightInput

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for IntentPreflightInput

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for IntentPreflightInput

impl JsonSchema for IntentPreflightInput

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 IntentPreflightInput

fn eq(&self, other: &IntentPreflightInput) -> 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 IntentPreflightInput

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 IntentPreflightInput