Struct Header 

#[non_exhaustive]
pub struct Header {
    pub metadata: BlockMetadata,
    pub title: Title,
    pub subtitle: Option<Subtitle>,
    pub authors: Vec<Author>,
    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

title: Title

subtitle: Option<Subtitle>

authors: Vec<Author>

location: Location

Implementations

impl Header

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

Create a new header with the given title and location.

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

Set the metadata.

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

Set the subtitle.

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

Set the authors.

Trait Implementations

impl Debug for Header

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Header

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Header

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

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 Header