Struct DocumentAttributes 

pub struct DocumentAttributes(/* 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 DocumentAttributes

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

Iterate over all attributes.

pub fn is_empty(&self) -> bool

Check if the attribute map is empty.

pub fn insert(&mut self, name: AttributeName, value: AttributeValue)

Insert a new attribute.

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

pub fn set(&mut self, name: AttributeName, value: AttributeValue)

Set an attribute, overwriting any existing value.

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

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>

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<String>

Helper to get a string value.

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

Trait Implementations

impl Clone for DocumentAttributes

fn clone(&self) -> DocumentAttributes

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentAttributes

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

Formats the value using the given formatter.

impl Default for DocumentAttributes

fn default() -> DocumentAttributes

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DocumentAttributes

fn deserialize<D>(deserializer: D) -> Result<DocumentAttributes, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for DocumentAttributes

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