Trait Document

pub trait Document {
    // Required methods
    fn document_type(&self) -> DocumentType;
    fn title(&self) -> &str;
    fn metadata(&self) -> &DocumentMetadata;
    fn content(&self) -> &DocumentContent;
    fn core(&self) -> &DocumentCore;
    fn can_transition_to(&self, phase: Phase) -> bool;
    fn transition_phase(
        &mut self,
        target_phase: Option<Phase>,
    ) -> Result<Phase, DocumentValidationError>;
    fn core_mut(&mut self) -> &mut DocumentCore;
    fn parent_id(&self) -> Option<&DocumentId>;
    fn blocked_by(&self) -> &[DocumentId];
    fn validate(&self) -> Result<(), DocumentValidationError>;
    fn exit_criteria_met(&self) -> bool;
    fn template(&self) -> DocumentTemplate;
    fn frontmatter_template(&self) -> &'static str;
    fn content_template(&self) -> &'static str;
    fn acceptance_criteria_template(&self) -> &'static str;

    // Provided methods
    fn id(&self) -> DocumentId { ... }
    fn tags(&self) -> &[Tag] { ... }
    fn phase(&self) -> Result<Phase, DocumentValidationError> { ... }
    fn update_section(
        &mut self,
        content: &str,
        heading: &str,
        append: bool,
    ) -> Result<(), DocumentValidationError> { ... }
    fn update_content_body(
        &mut self,
        new_body: String,
    ) -> Result<(), DocumentValidationError> { ... }
    fn archived(&self) -> bool { ... }
}

Core document trait that all document types must implement

Required Methods

fn document_type(&self) -> DocumentType

Get the document type

fn title(&self) -> &str

Get the document title

fn metadata(&self) -> &DocumentMetadata

Get the document metadata

fn content(&self) -> &DocumentContent

Get the document content

fn core(&self) -> &DocumentCore

Get access to the core document data

fn can_transition_to(&self, phase: Phase) -> bool

Check if this document can transition to the given phase

fn transition_phase( &mut self, target_phase: Option<Phase>, ) -> Result<Phase, DocumentValidationError>

Transition to the next phase in sequence, or to a specific phase if provided

fn core_mut(&mut self) -> &mut DocumentCore

Get mutable access to the document core (needed for updates)

fn parent_id(&self) -> Option<&DocumentId>

Get the parent document ID if this document has a parent

fn blocked_by(&self) -> &[DocumentId]

Get IDs of documents that block this one

fn validate(&self) -> Result<(), DocumentValidationError>

Validate the document according to its type-specific rules

fn exit_criteria_met(&self) -> bool

Check if exit criteria are met

fn template(&self) -> DocumentTemplate

Get the template for rendering this document type

fn frontmatter_template(&self) -> &'static str

Get the frontmatter template for this document type

fn content_template(&self) -> &'static str

Get the content template for this document type

fn acceptance_criteria_template(&self) -> &'static str

Get the acceptance criteria template for this document type

Provided Methods

fn id(&self) -> DocumentId

Get the unique identifier for this document (derived from title)

fn tags(&self) -> &[Tag]

Get the document tags

fn phase(&self) -> Result<Phase, DocumentValidationError>

Get the current phase of the document (parsed from tags)

fn update_section( &mut self, content: &str, heading: &str, append: bool, ) -> Result<(), DocumentValidationError>

Update a specific section (H2 heading) in the document content

fn update_content_body( &mut self, new_body: String, ) -> Result<(), DocumentValidationError>

Helper method for update_section to actually mutate the content

fn archived(&self) -> bool

Check if this document is archived

Implementors

impl Document for Adr

impl Document for Initiative

impl Document for Strategy

impl Document for Task

impl Document for Vision