Struct Header 

pub struct Header {
    pub title: String,
    pub authors: Vec<Author>,
    pub dates: Vec<DateEntry>,
    pub identifiers: Vec<Identifier>,
    pub version: Option<String>,
    pub description: Option<String>,
    pub provenance: Option<String>,
    pub source: Option<String>,
    pub meta: Vec<MetaEntry>,
}

Document header containing metadata

Fields

title: String

Document title (REQUIRED)

authors: Vec<Author>

Document authors (0 or more)

dates: Vec<DateEntry>

Document dates (created, modified, published, etc.) (0 or more)

identifiers: Vec<Identifier>

Document identifiers (0 or more)

version: Option<String>

Document version (0 or 1)

description: Option<String>

Document description (0 or 1)

provenance: Option<String>

Provenance information (0 or 1)

source: Option<String>

Source information (0 or 1)

meta: Vec<MetaEntry>

Custom metadata entries (0 or more)

Implementations

impl Header

pub fn new(title: String) -> Self

Create a new header with minimal required fields

pub fn add_author(&mut self, author: Author)

Add an author

pub fn add_date(&mut self, date: DateEntry)

Add a date entry

pub fn add_identifier(&mut self, identifier: Identifier)

Add an identifier

pub fn with_version(self, version: String) -> Self

Set version

pub fn with_description(self, description: String) -> Self

Set description

pub fn with_provenance(self, provenance: String) -> Self

Set provenance

pub fn with_source(self, source: String) -> Self

Set source

pub fn add_meta(&mut self, name: String, value: String)

Add metadata entry

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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