pub struct DesignDocument {Show 17 fields
pub title: String,
pub summary: String,
pub problem_statement: String,
pub goals: Vec<String>,
pub non_goals: Vec<String>,
pub project_context: Option<String>,
pub questions: Vec<ClarifyingQuestion>,
pub approaches: Vec<Approach>,
pub chosen_approach: usize,
pub choice_rationale: String,
pub architecture: String,
pub components: Vec<Component>,
pub data_flow: String,
pub file_plan: Vec<FileEntry>,
pub open_risks: Vec<String>,
pub author: Option<String>,
pub created_at: String,
}Expand description
The final design document.
Fields§
§title: StringTitle of the design.
summary: StringBrief summary / abstract.
problem_statement: StringProblem statement being solved.
goals: Vec<String>Key goals / requirements.
non_goals: Vec<String>Non-goals (explicitly out of scope).
project_context: Option<String>Context gathered from the project.
questions: Vec<ClarifyingQuestion>Clarifying questions and answers.
approaches: Vec<Approach>Candidate approaches that were considered.
chosen_approach: usizeIndex of the chosen approach (0-based).
choice_rationale: StringRationale for the choice.
architecture: StringArchitectural overview text.
components: Vec<Component>Components that make up the design.
data_flow: StringData flow description.
file_plan: Vec<FileEntry>Files that need to be created or modified.
open_risks: Vec<String>Open questions / risks remaining.
Author metadata.
created_at: StringCreation timestamp.
Trait Implementations§
Source§impl Clone for DesignDocument
impl Clone for DesignDocument
Source§fn clone(&self) -> DesignDocument
fn clone(&self) -> DesignDocument
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for DesignDocument
impl Debug for DesignDocument
Source§impl<'de> Deserialize<'de> for DesignDocument
impl<'de> Deserialize<'de> for DesignDocument
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Auto Trait Implementations§
impl Freeze for DesignDocument
impl RefUnwindSafe for DesignDocument
impl Send for DesignDocument
impl Sync for DesignDocument
impl Unpin for DesignDocument
impl UnsafeUnpin for DesignDocument
impl UnwindSafe for DesignDocument
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more