Struct GlossaryTerm 

pub struct GlossaryTerm {
    pub id: String,
    pub term: String,
    pub definition: String,
    pub aliases: Vec<String>,
    pub see_also: Vec<String>,
    pub category: Option<String>,
    pub pronunciation: Option<String>,
    pub etymology: Option<String>,
    pub usage: Option<String>,
}

A glossary term definition.

Fields

id: String

Unique identifier.

term: String

The term being defined.

definition: String

Definition text.

aliases: Vec<String>

Alternative forms or spellings.

see_also: Vec<String>

Related terms (by ID).

category: Option<String>

Category or subject area.

pronunciation: Option<String>

Pronunciation guide.

etymology: Option<String>

Etymology or origin.

usage: Option<String>

Usage notes.

Implementations

impl GlossaryTerm

pub fn new( id: impl Into<String>, term: impl Into<String>, definition: impl Into<String>, ) -> Self

Create a new glossary term.

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

Add an alias.

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

Add a “see also” reference.

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

Set category.

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

Set pronunciation.

Trait Implementations

impl Clone for GlossaryTerm

fn clone(&self) -> GlossaryTerm

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GlossaryTerm

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GlossaryTerm

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for GlossaryTerm

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for GlossaryTerm

impl StructuralPartialEq for GlossaryTerm