Struct Admonition 

#[non_exhaustive]
pub struct Admonition {
    pub metadata: BlockMetadata,
    pub variant: AdmonitionVariant,
    pub blocks: Vec<Block>,
    pub title: Title,
    pub location: Location,
}

An Admonition represents an admonition 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.

metadata: BlockMetadata

variant: AdmonitionVariant

blocks: Vec<Block>

title: Title

location: Location

Implementations

impl Admonition

pub fn new( variant: AdmonitionVariant, blocks: Vec<Block>, location: Location, ) -> Self

Create a new admonition with the given variant, blocks, and location.

pub fn with_metadata(self, metadata: BlockMetadata) -> Self

Set the metadata.

pub fn with_title(self, title: Title) -> Self

Set the title.

Trait Implementations

impl Clone for Admonition

fn clone(&self) -> Admonition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Admonition

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

Formats the value using the given formatter.

impl PartialEq for Admonition

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

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 Admonition