Struct Requirement

pub struct Requirement { /* private fields */ }

A requirement is a document used to describe a system.

It can represent a user requirement, a specification, etc. Requirements can have dependencies between them, such that one requirement satisfies, fulfils, verifies (etc.) another requirement.

Implementations

impl Requirement

pub fn new(hrid: Hrid, content: String) -> Self

Construct a new Requirement from a human-readable ID and its content.

A new UUID is automatically generated.

pub fn content(&self) -> &str

The body of the requirement.

This should be a markdown document.

pub const fn tags(&self) -> &BTreeSet<String>

The tags on the requirement

pub fn set_tags(&mut self, tags: BTreeSet<String>)

Set the tags on the requirement.

this replaces any existing tags.

pub fn add_tag(&mut self, tag: String) -> bool

Add a tag to the requirement.

returns ‘true’ if a new tag was inserted, or ‘false’ if it was already present.

pub const fn hrid(&self) -> &Hrid

The human-readable identifier for this requirement.

In normal usage these should be stable

pub const fn uuid(&self) -> Uuid

The unique, stable identifier of this requirement

pub const fn created(&self) -> DateTime<Utc>

When the requirement was first created

pub fn fingerprint(&self) -> String

Returns a value generated by hashing the content of the Requirement.

Any change to the requirement will change the fingerprint. This is used to determine when links are ‘suspect’. Meaning that because a requirement has been modified, related or dependent requirements also need to be reviewed to ensure consistency.

pub fn add_parent( &mut self, parent_id: Uuid, parent_info: Parent, ) -> Option<Parent>

Add a parent to the requirement, keyed by UUID.

pub fn parents(&self) -> impl Iterator<Item = (Uuid, &Parent)>

Return an iterator over the requirement’s ‘parents’

pub fn parents_mut(&mut self) -> impl Iterator<Item = (Uuid, &mut Parent)>

Return a mutable iterator over the requirement’s ‘parents’

pub fn load(path: &Path, hrid: String) -> Result<Self, LoadError>

Reads a requirement from the given file path.

Note the path here is the path to the directory. The filename is determined by the HRID

Errors

Returns an error if the file does not exist, cannot be read from, or has malformed YAML frontmatter.

pub fn save(&self, path: &Path) -> Result<()>

Writes the requirement to the given file path. Creates the file if it doesn’t exist, or overwrites it if it does.

Note the path here is the path to the directory. The filename is determined by the HRID.

Errors

This method returns an error if the path cannot be written to.

Trait Implementations

impl Clone for Requirement

fn clone(&self) -> Requirement

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Requirement

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

Formats the value using the given formatter.

impl PartialEq for Requirement

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Requirement