Struct EmbedElem

pub struct EmbedElem {
    pub path: Derived<EcoString, EcoString>,
    pub data: Bytes,
    /* private fields */
}

A file that will be embedded into the output PDF.

This can be used to distribute additional files that are related to the PDF within it. PDF readers will display the files in a file listing.

Some international standards use this mechanism to embed machine-readable data (e.g., ZUGFeRD/Factur-X for invoices) that mirrors the visual content of the PDF.

Example

#pdf.embed(
  "experiment.csv",
  relationship: "supplement",
  mime-type: "text/csv",
  description: "Raw Oxygen readings from the Arctic experiment",
)

Notes

• This element is ignored if exporting to a format other than PDF.
• File embeddings are not currently supported for PDF/A-2, even if the embedded file conforms to PDF/A-1 or PDF/A-2.

Fields

path: Derived<EcoString, EcoString>

data: Bytes

Implementations

impl EmbedElem

pub fn new(path: Derived<EcoString, EcoString>, data: Bytes) -> Self

Create a new instance of the element.

pub fn with_relationship( self, relationship: Option<EmbeddedFileRelationship>, ) -> Self

Builder-style setter for the relationship field.

pub fn with_mime_type(self, mime_type: Option<EcoString>) -> Self

Builder-style setter for the mime-type field.

pub fn with_description(self, description: Option<EcoString>) -> Self

Builder-style setter for the description field.

pub fn push_relationship( &mut self, relationship: Option<EmbeddedFileRelationship>, )

Setter for the relationship field.

pub fn push_mime_type(&mut self, mime_type: Option<EcoString>)

Setter for the mime-type field.

pub fn push_description(&mut self, description: Option<EcoString>)

Setter for the description field.

pub fn relationship( &self, styles: StyleChain<'_>, ) -> Option<EmbeddedFileRelationship>

The relationship of the embedded file to the document.

Ignored if export doesn’t target PDF/A-3.

pub fn mime_type<'a>(&'a self, styles: StyleChain<'a>) -> &'a Option<EcoString>

The MIME type of the embedded file.

pub fn description<'a>( &'a self, styles: StyleChain<'a>, ) -> &'a Option<EcoString>

A description for the embedded file.

pub fn relationship_in( styles: StyleChain<'_>, ) -> Option<EmbeddedFileRelationship>

Access the relationship field in the given style chain.

pub fn mime_type_in(styles: StyleChain<'_>) -> &Option<EcoString>

Access the mime-type field in the given style chain.

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

Access the description field in the given style chain.

pub fn set_relationship( relationship: Option<EmbeddedFileRelationship>, ) -> Property

Create a style property for the relationship field.

pub fn set_mime_type(mime_type: Option<EcoString>) -> Property

Create a style property for the mime-type field.

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

Create a style property for the description field.

Trait Implementations

impl Capable for EmbedElem

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

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

impl Clone for EmbedElem

fn clone(&self) -> EmbedElem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Construct for EmbedElem

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

Construct an element from the arguments.

impl Debug for EmbedElem

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

Formats the value using the given formatter.

impl Fields for EmbedElem

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 EmbedElem

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 EmbedElem

fn into_value(self) -> Value

Cast this type into a value.

impl NativeElement for EmbedElem

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 EmbedElem

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 EmbedElem

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl Set for EmbedElem

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

Parse relevant arguments into style properties for this element.