Struct DescriptionListItem 

#[non_exhaustive]
pub struct DescriptionListItem {
    pub anchors: Vec<Anchor>,
    pub term: Vec<InlineNode>,
    pub delimiter: String,
    pub principal_text: Vec<InlineNode>,
    pub description: Vec<Block>,
    pub location: Location,
}

An item in a description list (term + description).

Structure

term:: principal text    <- term, delimiter, principal_text
       description       <- description (blocks)

Note on Field Names

• description is singular (not descriptions) - it holds the block content following the term
• principal_text is inline content immediately after the delimiter on the same line

fn has_description(item: &DescriptionListItem) -> bool {
    !item.description.is_empty()  // Note: singular 'description'
}

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.

anchors: Vec<Anchor>

Optional anchors (IDs) attached to this item.

term: Vec<InlineNode>

The term being defined (inline content before the delimiter).

delimiter: String

The delimiter used (::, :::, ::::, or ;;).

principal_text: Vec<InlineNode>

Inline content immediately after the delimiter on the same line.

description: Vec<Block>

Block content providing the description (singular, not plural).

location: Location

Trait Implementations

impl Clone for DescriptionListItem

fn clone(&self) -> DescriptionListItem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DescriptionListItem

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DescriptionListItem

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for DescriptionListItem

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DescriptionListItem