Skip to main content

CompileInput

Struct CompileInput 

Source
pub struct CompileInput {
    pub issue: Option<String>,
    pub milestone: Option<String>,
    pub intent: Option<String>,
    pub paths: Vec<String>,
    pub uris: Vec<String>,
    pub budget_tokens: Option<u64>,
    pub max_depth: Option<usize>,
    pub floor: Option<f64>,
    pub all_blocking_rules: Option<bool>,
}
Expand description

What to compile a context about.

Every field is optional. A request that names nothing still gets an answer: the governance the layer applies to everything, and what the last session left — which is the smallest true context there is.

The seeds are additive, not alternative: issue, milestone, uris, paths and intent all contribute, and naming several is the normal case rather than a conflict. intent is the only one the compiler infers from, which is why every entry it produces carries Selector::IntentMatch and a confidence below one.

deny_unknown_fields is deliberate. This is the input of a served capability, so a misspelled field is a request that does not mean what its author thought; refusing it is the difference between a typo and a silently smaller answer.

use majordomus_cli::devcontext::CompileInput;
use serde_json::json;

// the smallest legitimate request, which is not the same as no request
let nothing: CompileInput = serde_json::from_value(json!({})).unwrap();
assert_eq!(nothing, CompileInput::default());
assert!(nothing.issue.is_none() && nothing.paths.is_empty());

// the seeds combine rather than compete
let both: CompileInput = serde_json::from_value(json!({
    "issue": "I0301",
    "paths": ["apps/majordomus-cli/src"],
    "intent": "explain the budget",
    "budget_tokens": 4_000,
})).unwrap();
assert_eq!(both.issue.as_deref(), Some("I0301"));
assert_eq!(both.paths, ["apps/majordomus-cli/src"]);
assert_eq!(both.budget_tokens, Some(4_000));

// and a misspelled field is refused rather than quietly ignored
let typo = serde_json::from_value::<CompileInput>(json!({"max_dept": 2}));
assert!(typo.is_err(), "a typo must not become a smaller answer");

Fields§

§issue: Option<String>

An issue id (I0301) or its canonical identifier. Its milestone, its dependencies, its declared scope and the decisions over that scope follow from it.

§milestone: Option<String>

A milestone id or slug, or its canonical identifier.

§intent: Option<String>

What the session is trying to do, in words. The only input the compiler infers from, and every entry it produces says so and carries a confidence below one.

§paths: Vec<String>

Repository-relative paths the work touches, added to whatever the seeds declare.

§uris: Vec<String>

Canonical identifiers to seed with directly, for a request about something that is neither an issue nor a milestone.

§budget_tokens: Option<u64>

The ceiling in estimated tokens; DEFAULT_BUDGET_TOKENS when absent.

§max_depth: Option<usize>

How far from a seed the walk goes; DEFAULT_MAX_DEPTH when absent.

§floor: Option<f64>

Relevance below which an entry is reported rather than given; DEFAULT_FLOOR when absent.

§all_blocking_rules: Option<bool>

Every blocking rule of the layer, not only the ones the work reaches. Honest and usually over budget: the answer then says over_budget rather than dropping what it may not drop.

Trait Implementations§

Source§

impl BenchmarkCases for CompileInput

Source§

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.
Source§

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

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

impl Clone for CompileInput

Source§

fn clone(&self) -> CompileInput

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CompileInput

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for CompileInput

Source§

fn default() -> CompileInput

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for CompileInput

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl JsonSchema for CompileInput

Source§

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

The name of the generated JSON Schema. Read more
Source§

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

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

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

Generates a JSON Schema for this type. Read more
Source§

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. Read more
Source§

impl PartialEq for CompileInput

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl Serialize for CompileInput

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for CompileInput

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more