Struct BlockMetadata 

#[non_exhaustive]
pub struct BlockMetadata<'a> {
    pub attributes: ElementAttributes<'a>,
    pub roles: Vec<Role<'a>>,
    pub options: Vec<&'a str>,
    pub style: Option<&'a str>,
    pub id: Option<Anchor<'a>>,
    pub anchors: Vec<Anchor<'a>>,
    pub substitutions: Option<SubstitutionSpec>,
    pub attribution: Option<Attribution<'a>>,
    pub citetitle: Option<CiteTitle<'a>>,
    pub location: Option<Location>,
    /* private fields */
}

A BlockMetadata represents the metadata of a block in a document.

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.

attributes: ElementAttributes<'a>

roles: Vec<Role<'a>>

options: Vec<&'a str>

style: Option<&'a str>

id: Option<Anchor<'a>>

anchors: Vec<Anchor<'a>>

substitutions: Option<SubstitutionSpec>

Substitutions to apply to block content.

• None: Use block-type defaults (VERBATIM for listing/literal, NORMAL for paragraphs)
• Some(Explicit([])): No substitutions (equivalent to subs=none)
• Some(Explicit(list)): Use the explicit list of substitutions
• Some(Modifiers(ops)): Apply modifier operations to block-type defaults

attribution: Option<Attribution<'a>>

citetitle: Option<CiteTitle<'a>>

location: Option<Location>

Implementations

impl<'a> BlockMetadata<'a>

pub fn new() -> Self

Create a new block metadata with default values.

pub fn with_attributes(self, attributes: ElementAttributes<'a>) -> Self

Set the attributes.

pub fn with_options(self, options: Vec<&'a str>) -> Self

Set the options.

pub fn with_roles(self, roles: Vec<Role<'a>>) -> Self

Set the roles.

pub fn with_style(self, style: Option<&'a str>) -> Self

Set the style.

pub fn with_id(self, id: Option<Anchor<'a>>) -> Self

Set the ID.

pub fn is_default(&self) -> bool

Trait Implementations

impl<'a> Clone for BlockMetadata<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for BlockMetadata<'a>

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

Formats the value using the given formatter.

impl<'a> Default for BlockMetadata<'a>

fn default() -> BlockMetadata<'a>

Returns the “default value” for a type.

impl<'a> PartialEq for BlockMetadata<'a>

fn eq(&self, other: &BlockMetadata<'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 BlockMetadata<'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 BlockMetadata<'a>