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.

pub fn title_in(styles: StyleChain<'_>) -> Option<Content>

Access the title field in the given style chain.

pub fn author_in(styles: StyleChain<'_>) -> OneOrMultiple<EcoString>

Access the author field in the given style chain.

pub fn description_in(styles: StyleChain<'_>) -> Option<Content>

Access the description field in the given style chain.

pub fn keywords_in(styles: StyleChain<'_>) -> OneOrMultiple<EcoString>

Access the keywords field in the given style chain.

pub fn date_in(styles: StyleChain<'_>) -> Smart<Option<Datetime>>

Access the date field in the given style chain.

pub fn set_title(title: Option<Content>) -> Property

Create a style property for the title field.

pub fn set_author(author: OneOrMultiple<EcoString>) -> Property

Create a style property for the author field.

pub fn set_description(description: Option<Content>) -> Property

Create a style property for the description field.

pub fn set_keywords(keywords: OneOrMultiple<EcoString>) -> Property

Create a style property for the keywords field.

pub fn set_date(date: Smart<Option<Datetime>>) -> Property

Create a style property for the date field.

Trait Implementations

impl Capable for DocumentElem

fn vtable(capability: TypeId) -> Option<NonNull<()>>

Get the pointer to the vtable for the given capability / trait.

impl Clone for DocumentElem

fn clone(&self) -> DocumentElem

Returns a duplicate of the value.

const 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 Fields for DocumentElem

type Enum = Fields

An enum with the fields of the element.

fn has(&self, id: u8) -> bool

Whether the element has the given field set.

fn field(&self, id: u8) -> Result<Value, FieldAccessError>

Get the field with the given field ID.

fn field_with_styles( &self, id: u8, styles: StyleChain<'_>, ) -> Result<Value, FieldAccessError>

Get the field with the given ID in the presence of styles.

fn field_from_styles( id: u8, styles: StyleChain<'_>, ) -> Result<Value, FieldAccessError>

Get the field with the given ID from the styles.

fn materialize(&mut self, styles: StyleChain<'_>)

Resolve all fields with the styles and save them in-place.

fn fields(&self) -> Dict

Get the fields of the element.

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 IntoValue for DocumentElem

fn into_value(self) -> Value

Cast this type into a value.

impl NativeElement for DocumentElem

fn data() -> &'static NativeElementData

Get the element data for the native Rust element.

fn elem() -> Element

where Self: Sized,

Get the element for the native Rust element.

fn pack(self) -> Content

where Self: Sized,

Pack the element into type-erased content.

impl PartialEq for DocumentElem

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

const 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 Repr for DocumentElem

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl Set for DocumentElem

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

Parse relevant arguments into style properties for this element.