Struct Header 

#[non_exhaustive]
pub struct Header<'a> {
    pub metadata: BlockMetadata<'a>,
    pub title: Title<'a>,
    pub subtitle: Option<Subtitle<'a>>,
    pub authors: Vec<Author<'a>>,
    pub location: Location,
}

A Header represents the header of a document.

The header contains the title, subtitle, authors, and optional metadata (such as ID and roles) that can be applied to the document title.

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

title: Title<'a>

subtitle: Option<Subtitle<'a>>

authors: Vec<Author<'a>>

location: Location

Implementations

impl<'a> Header<'a>

pub fn new(title: Title<'a>, location: Location) -> Self

Create a new header with the given title and location.

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

Set the metadata.

pub fn with_subtitle(self, subtitle: Subtitle<'a>) -> Self

Set the subtitle.

pub fn with_authors(self, authors: Vec<Author<'a>>) -> Self

Set the authors.

Trait Implementations

impl<'a> Debug for Header<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for Header<'a>

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