Enum ItemAttributes 

pub enum ItemAttributes {
    Solution,
    UseCase,
    Scenario,
    SystemRequirement {
        specification: String,
        depends_on: Vec<ItemId>,
    },
    SystemArchitecture {
        platform: Option<String>,
    },
    SoftwareRequirement {
        specification: String,
        depends_on: Vec<ItemId>,
    },
    HardwareRequirement {
        specification: String,
        depends_on: Vec<ItemId>,
    },
    SoftwareDetailedDesign,
    HardwareDetailedDesign,
    Adr {
        status: AdrStatus,
        deciders: Vec<String>,
        supersedes: Vec<ItemId>,
    },
}

Type-specific attributes for items in the knowledge graph.

Variants

Solution

Solution - no type-specific attributes.

UseCase

Use Case - no type-specific attributes beyond upstream refs.

Scenario

Scenario - no type-specific attributes beyond upstream refs.

SystemRequirement

System Requirement with specification and peer dependencies.

Fields

specification: String

Specification statement.

depends_on: Vec<ItemId>

Peer dependencies.

SystemArchitecture

System Architecture with platform.

Fields

platform: Option<String>

Target platform.

SoftwareRequirement

Software Requirement with specification and peer dependencies.

Fields

specification: String

Specification statement.

depends_on: Vec<ItemId>

Peer dependencies.

HardwareRequirement

Hardware Requirement with specification and peer dependencies.

Fields

specification: String

Specification statement.

depends_on: Vec<ItemId>

Peer dependencies.

SoftwareDetailedDesign

Software Detailed Design.

HardwareDetailedDesign

Hardware Detailed Design.

Adr

Architecture Decision Record with ADR-specific fields.

Fields

status: AdrStatus

ADR lifecycle status.

deciders: Vec<String>

List of people involved in the decision.

supersedes: Vec<ItemId>

Older ADRs this decision supersedes (peer relationship).

Implementations

impl ItemAttributes

pub fn for_type(item_type: ItemType) -> Self

Creates default attributes for the given item type.

pub fn specification(&self) -> Option<&String>

Returns the specification if this is a requirement type.

pub fn depends_on(&self) -> &[ItemId]

Returns the depends_on references if this is a requirement type.

pub fn platform(&self) -> Option<&String>

Returns the platform if this is a SystemArchitecture.

pub fn status(&self) -> Option<AdrStatus>

Returns the ADR status if this is an ADR.

pub fn deciders(&self) -> &[String]

Returns the deciders if this is an ADR.

pub fn supersedes(&self) -> &[ItemId]

Returns the supersedes references if this is an ADR.

Trait Implementations

impl Clone for ItemAttributes

fn clone(&self) -> ItemAttributes

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ItemAttributes

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

Formats the value using the given formatter.

impl Default for ItemAttributes

fn default() -> ItemAttributes

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ItemAttributes

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ItemAttributes

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

where __S: Serializer,

Serialize this value into the given Serde serializer.