Struct Attrlist

pub struct Attrlist<'src> { /* private fields */ }

The source text that’s used to define attributes for an element is referred to as an attrlist. An attrlist is always enclosed in a pair of square brackets. This applies for block attributes as well as attributes on a block or inline macro. The processor splits the attrlist into individual attribute entries, determines whether each entry is a positional or named attribute, parses the entry accordingly, and assigns the result as an attribute on the node.

Implementations

impl<'src> Attrlist<'src>

pub fn attributes(&'src self) -> Iter<'src, ElementAttribute<'src>>

Returns an iterator over the attributes contained within this attrlist.

pub fn named_attribute( &'src self, name: &str, ) -> Option<&'src ElementAttribute<'src>>

Returns the first attribute with the given name.

pub fn nth_attribute( &'src self, n: usize, ) -> Option<&'src ElementAttribute<'src>>

Returns the given (1-based) positional attribute.

IMPORTANT: Named attributes with names are disregarded when counting.

pub fn named_or_positional_attribute( &'src self, name: &str, index: usize, ) -> Option<&'src ElementAttribute<'src>>

Returns the first attribute with the given name or index.

Some block and macro types provide implicit mappings between attribute names and positions to permit a shorthand syntax.

This method will search by name first, and fall back to positional indexing if the name doesn’t yield a match.

pub fn id(&'src self) -> Option<Span<'src>>

Returns the ID attribute (if any).

You can assign an ID to a block using the shorthand syntax, the longhand syntax, or a legacy block anchor.

In the shorthand syntax, you prefix the name with a hash (#) in the first position attribute:

[#goals]
* Goal 1
* Goal 2

In the longhand syntax, you use a standard named attribute:

[id=goals]
* Goal 1
* Goal 2

In the legacy block anchor syntax, you surround the name with double square brackets:

[[goals]]
* Goal 1
* Goal 2

Trait Implementations

impl<'src> Clone for Attrlist<'src>

fn clone(&self) -> Attrlist<'src>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'src> Debug for Attrlist<'src>

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

Formats the value using the given formatter.

impl<'src> HasSpan<'src> for Attrlist<'src>

fn span(&'src self) -> &'src Span<'src>

Return a Span describing the syntactic element’s location within the source string/file.

impl<'src> PartialEq for Attrlist<'src>

fn eq(&self, other: &Attrlist<'src>) -> 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<'src> Eq for Attrlist<'src>

impl<'src> StructuralPartialEq for Attrlist<'src>