Struct Term 

#[non_exhaustive]
pub struct Term {
    pub value: String,
    pub label: Option<String>,
    pub description: Option<String>,
    pub retired: bool,
    pub tint: Option<Tint>,
}

One term of a controlled vocabulary.

#[non_exhaustive]: a term gains display and lifecycle facets over time, so it is built from Term::value and the chainable setters rather than a struct literal. Reading the fields is unchanged.

use fig_schema::Term;

let t = Term::value("archived").label("Archived").retired(true);
assert_eq!(t.display_label(), "Archived");
assert!(t.retired);

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

value: String

The stored value.

label: Option<String>

A human display label (defaults to value — see Term::display_label).

description: Option<String>

A human gloss / help text.

retired: bool

Known but no longer offered: still valid where already present, excluded from the picker’s offered set. Validating one yields Validation::Warn rather than Validation::Reject, even under a closed vocabulary — see validate_enum.

tint: Option<Tint>

A per-value tint (e.g. public = positive/green).

Implementations

impl Term

pub fn value(v: impl Into<String>) -> Self

A bare live term with just a value.

pub fn label(self, label: impl Into<String>) -> Self

Set the display label.

pub fn label_opt(self, label: Option<impl Into<String>>) -> Self

Set the display label from an optional one. None leaves it unset.

pub fn description(self, description: impl Into<String>) -> Self

Set the human gloss.

pub fn description_opt(self, description: Option<impl Into<String>>) -> Self

Set the human gloss from an optional one. None leaves it unset.

pub fn retired(self, retired: bool) -> Self

Mark the term retired — known, but no longer offered.

pub fn tint(self, tint: impl Into<Option<Tint>>) -> Self

Set the per-value tint. Takes a Tint or an Option<Tint>.

pub fn display_label(&self) -> &str

The text to display for this term: Term::label if set, otherwise the stored Term::value.

Trait Implementations

impl Clone for Term

fn clone(&self) -> Term

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Term

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

Formats the value using the given formatter.

impl Eq for Term

impl PartialEq for Term

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Term