Skip to main content

ReviewReport

Struct ReviewReport 

Source
pub struct ReviewReport {
Show 16 fields pub feature: String, pub file: String, pub requirements: Vec<ReviewItem>, pub totals: ReviewTotals, pub revise_with: Option<String>, pub revision: Option<String>, pub questions: Vec<OpenQuestion>, pub changes: Vec<ReviewChange>, pub history: Vec<SpecVersion>, pub oracle: Vec<OracleView>, pub tests_notice: Option<String>, pub bug_tests: Vec<BugTests>, pub approval: Option<ReviewApproval>, pub sheet: Option<ApproveSheet>, pub error: Option<String>, pub readiness: Option<Readiness>,
}
Expand description

Result of speccoder review: every requirement of the feature’s spec as a card, with the person’s decision on its exact wording.

Fields§

§feature: String

The feature.

§file: String

Where the review is recorded (project-relative); commit it to share.

§requirements: Vec<ReviewItem>

One per requirement, in the spec’s order.

§totals: ReviewTotals

Counts by state.

§revise_with: Option<String>

The format’s skill that revises the spec from the comments (Spec Kit: clarify), when it has one.

§revision: Option<String>

What that skill is asked, while changes are requested: every request with its requirement.

§questions: Vec<OpenQuestion>

The questions the documents leave open ([NEEDS CLARIFICATION: …]), in reading order.

§changes: Vec<ReviewChange>

Requirements changed in the checkout since the last commit of the spec: what a commit would record.

§history: Vec<SpecVersion>

The spec’s versions in git, newest first (the last twelve).

§oracle: Vec<OracleView>

One per requirement with scenarios (US1), beside the decision lines: the tests the run would use, as written at review.

§tests_notice: Option<String>

Why the review writes no tests for this unit: its own pipeline authors and confirms them (a quick change, a bug).

§bug_tests: Vec<BugTests>

A bug unit’s confirmed reproductions, read only.

§approval: Option<ReviewApproval>

The approval that froze the oracle, when one is recorded.

§sheet: Option<ApproveSheet>

What Approve and Run would do and what blocks it (the full review only).

§error: Option<String>

Why the review record (review.json) cannot be read: shown, never read as “nothing decided” by a write.

§readiness: Option<Readiness>

What the future oracle will be made of, counted now.

Trait Implementations§

Source§

impl Clone for ReviewReport

Source§

fn clone(&self) -> Self

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 ReviewReport

Source§

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

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

impl Eq for ReviewReport

Source§

impl JsonSchema for ReviewReport

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 ReviewReport

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for ReviewReport

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 ReviewReport

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

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.

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.