Enum FieldName 

pub enum FieldName {
    Id,
    Type,
    Name,
    Description,
    Refines,
    DerivesFrom,
    Satisfies,
    IsRefinedBy,
    Derives,
    IsSatisfiedBy,
    DependsOn,
    IsRequiredBy,
    Specification,
    Platform,
    JustifiedBy,
}

All field names used in YAML frontmatter.

Variants

Id

Type

Name

Description

Refines

DerivesFrom

Satisfies

IsRefinedBy

Derives

IsSatisfiedBy

DependsOn

IsRequiredBy

Specification

Platform

JustifiedBy

Implementations

impl FieldName

pub const fn all() -> &'static [FieldName]

Returns all known field names.

pub const fn as_str(&self) -> &'static str

Returns the YAML field name (snake_case).

Used for serialization, deserialization, and error messages.

pub const fn display_name(&self) -> &'static str

Returns the human-readable display name.

Used for user-facing output like change summaries.

pub const fn is_upstream(&self) -> bool

Returns true if this is an upstream traceability field.

pub const fn is_downstream(&self) -> bool

Returns true if this is a downstream traceability field.

pub const fn is_peer(&self) -> bool

Returns true if this is a peer relationship field.

pub const fn is_traceability(&self) -> bool

Returns true if this is a traceability field (upstream, downstream, or peer).

Trait Implementations

impl Clone for FieldName

fn clone(&self) -> FieldName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FieldName

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

Formats the value using the given formatter.

impl Display for FieldName

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

Formats the value using the given formatter.

impl Hash for FieldName

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for FieldName

fn eq(&self, other: &FieldName) -> 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 Copy for FieldName

impl Eq for FieldName

impl StructuralPartialEq for FieldName