Struct DocumentAttributes 

pub struct DocumentAttributes<'a>(/* private fields */);

Document-level attributes with universal defaults.

These attributes apply to the entire document and include defaults for admonition captions, TOC settings, structural settings, etc.

Use DocumentAttributes::default() to get a map with universal defaults applied.

Implementations

impl<'a> DocumentAttributes<'a>

pub fn iter( &self, ) -> impl Iterator<Item = (&AttributeName<'a>, &AttributeValue<'a>)>

Iterate over all attributes.

pub fn is_empty(&self) -> bool

Check if the attribute map is empty.

pub fn insert(&mut self, name: AttributeName<'a>, value: AttributeValue<'a>)

Insert a new attribute.

NOTE: This will NOT overwrite an existing attribute with the same name.

pub fn set(&mut self, name: AttributeName<'a>, value: AttributeValue<'a>)

Set an attribute, overwriting any existing value.

pub fn get(&self, name: &str) -> Option<&AttributeValue<'a>>

Get an attribute value by name.

pub fn contains_key(&self, name: &str) -> bool

Check if an attribute exists.

pub fn remove(&mut self, name: &str) -> Option<AttributeValue<'a>>

Remove an attribute by name.

pub fn merge(&mut self, other: Self)

Merge another attribute map into this one.

pub fn get_string(&self, name: &str) -> Option<Cow<'a, str>>

Helper to get a string value.

Strips surrounding quotes from the value if present (parser quirk workaround).

pub fn to_static(&self) -> DocumentAttributes<'static>

Clone the attributes into an independent 'static copy. Used by converters that cache document attributes on a processor whose lifetime is independent of the document being rendered.

pub fn into_static(self) -> DocumentAttributes<'static>

Consume the attributes, producing an independent 'static copy.

Trait Implementations

impl<'a> Clone for DocumentAttributes<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for DocumentAttributes<'a>

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

Formats the value using the given formatter.

impl<'a> Default for DocumentAttributes<'a>

fn default() -> DocumentAttributes<'a>

Returns the “default value” for a type.

impl<'a> PartialEq for DocumentAttributes<'a>

fn eq(&self, other: &DocumentAttributes<'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 Serialize for DocumentAttributes<'_>

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 DocumentAttributes<'a>