Struct DescriptionListItem 

#[non_exhaustive]
pub struct DescriptionListItem<'a> {
    pub anchors: Vec<Anchor<'a>>,
    pub term: Vec<InlineNode<'a>>,
    pub delimiter: &'a str,
    pub delimiter_location: Option<Location>,
    pub principal_text: Vec<InlineNode<'a>>,
    pub description: Vec<Block<'a>>,
    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<'a>>

Optional anchors (IDs) attached to this item.

term: Vec<InlineNode<'a>>

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

delimiter: &'a str

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

delimiter_location: Option<Location>

Location of the delimiter in the source.

principal_text: Vec<InlineNode<'a>>

Inline content immediately after the delimiter on the same line.

description: Vec<Block<'a>>

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

location: Location

Trait Implementations

impl<'a> Clone for DescriptionListItem<'a>

fn clone(&self) -> DescriptionListItem<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for DescriptionListItem<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for DescriptionListItem<'a>

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> StructuralPartialEq for DescriptionListItem<'a>