Struct DocumentElem 

pub struct DocumentElem {}

The root element of a document and its metadata.

All documents are automatically wrapped in a document element. You cannot create a document element yourself. This function is only used with set rules to specify document metadata. Such a set rule must not occur inside of any layout container.

#set document(title: [Hello])

This has no visible output, but
embeds metadata into the PDF!

Note that metadata set with this function is not rendered within the document. Instead, it is embedded in the compiled PDF file.

Implementations

impl DocumentElem

pub fn new() -> Self

Create a new instance of the element.

impl DocumentElem

pub const title: Field<Self, 0u8>

pub const author: Field<Self, 1u8>

pub const description: Field<Self, 2u8>

pub const keywords: Field<Self, 3u8>

pub const date: Field<Self, 4u8>

Trait Implementations

impl Clone for DocumentElem

fn clone(&self) -> DocumentElem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Construct for DocumentElem

fn construct(_: &mut Engine<'_>, args: &mut Args) -> SourceResult<Content>

Construct an element from the arguments.

impl Debug for DocumentElem

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

Formats the value using the given formatter.

impl Hash for DocumentElem

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl NativeElement for DocumentElem

const ELEM: Element

The associated element.

fn pack(self) -> Content

Pack the element into type-erased content.

impl Set for DocumentElem

fn set(engine: &mut Engine<'_>, args: &mut Args) -> SourceResult<Styles>

Parse relevant arguments into style properties for this element.

impl SettableProperty<0> for DocumentElem

const FIELD: SettablePropertyData<Self, 0u8>

type Type = Option<Content>

const FOLD: Option<FoldFn<Self::Type>> = _

fn default() -> Self::Type

Produces an instance of the property’s default value.

fn default_ref() -> &'static Self::Type

Produces a static reference to this property’s default value.

impl SettableProperty<1> for DocumentElem

const FIELD: SettablePropertyData<Self, 1u8>

type Type = OneOrMultiple<EcoString>

const FOLD: Option<FoldFn<Self::Type>> = _

fn default() -> Self::Type

Produces an instance of the property’s default value.

fn default_ref() -> &'static Self::Type

Produces a static reference to this property’s default value.

impl SettableProperty<2> for DocumentElem

const FIELD: SettablePropertyData<Self, 2u8>

type Type = Option<Content>

const FOLD: Option<FoldFn<Self::Type>> = _

fn default() -> Self::Type

Produces an instance of the property’s default value.

fn default_ref() -> &'static Self::Type

Produces a static reference to this property’s default value.

impl SettableProperty<3> for DocumentElem

const FIELD: SettablePropertyData<Self, 3u8>

type Type = OneOrMultiple<EcoString>

const FOLD: Option<FoldFn<Self::Type>> = _

fn default() -> Self::Type

Produces an instance of the property’s default value.

fn default_ref() -> &'static Self::Type

Produces a static reference to this property’s default value.

impl SettableProperty<4> for DocumentElem

const FIELD: SettablePropertyData<Self, 4u8>

type Type = Smart<Option<Datetime>>

const FOLD: Option<FoldFn<Self::Type>> = _

fn default() -> Self::Type

Produces an instance of the property’s default value.

fn default_ref() -> &'static Self::Type

Produces a static reference to this property’s default value.

impl RefableProperty<0> for DocumentElem

impl RefableProperty<1> for DocumentElem

impl RefableProperty<2> for DocumentElem

impl RefableProperty<3> for DocumentElem

impl RefableProperty<4> for DocumentElem