Skip to main content

AttachmentOptions

Struct AttachmentOptions 

Source
#[non_exhaustive]
pub struct AttachmentOptions { pub description: Option<String>, pub mime_type: Option<String>, pub modified: Option<String>, }
Expand description

What an attachment carries besides its name and bytes.

A config struct with Default. #[non_exhaustive] so a field added later is not a major break; fill one in with AttachmentOptions::builder. Every field is optional and an absent one writes no key.

use pdfrum_edit::AttachmentOptions;

let options = AttachmentOptions::builder()
    .description("The source data")
    .mime_type("text/csv")
    .build();
assert!(options.modified.is_none());

Fields (Non-exhaustive)§

This struct is marked as 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.
§description: Option<String>

The file specification’s /Desc, the text a viewer shows beside the name. Read back by Attachment::description.

§mime_type: Option<String>

The embedded file’s MIME type — text/plain, application/pdf — written as the stream’s /Subtype name. Read back by the facade’s Attachment::subtype.

§modified: Option<String>

The file’s own modification time as a PDF date string (D:YYYYMMDDHHmmSS…, ISO 32000-1 §7.9.4), written to /Params /ModDate. pdf_date spells a SystemTime that way. Read back by the facade’s Attachment::param.

Implementations§

Source§

impl AttachmentOptions

Source

pub fn builder() -> AttachmentOptionsBuilder

A builder starting from the defaults.

let options = pdfrum::AttachmentOptions::builder().mime_type("text/csv").build();

Trait Implementations§

Source§

impl Clone for AttachmentOptions

Source§

fn clone(&self) -> AttachmentOptions

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AttachmentOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for AttachmentOptions

Source§

fn default() -> AttachmentOptions

Returns the “default value” for a type. Read more
Source§

impl Eq for AttachmentOptions

Source§

impl PartialEq for AttachmentOptions

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for AttachmentOptions

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.