Struct DocumentOptions

pub struct DocumentOptions {

    pub trace_id: Option<String>,
    pub password: Option<String>,
    pub landscape: Option<bool>,
    pub native_page_ranges: Option<PageRange>,
    pub export_form_fields: Option<bool>,
    pub allow_duplicate_field_names: Option<bool>,
    pub export_bookmarks: Option<bool>,
    pub export_bookmarks_to_pdf_destination: Option<bool>,
    pub export_placeholders: Option<bool>,
    pub export_notes: Option<bool>,
    pub export_notes_pages: Option<bool>,
    pub export_only_notes_pages: Option<bool>,
    pub export_notes_in_margin: Option<bool>,
    pub convert_ooo_target_to_pdf_target: Option<bool>,
    pub export_links_relative_fsys: Option<bool>,
    pub export_hidden_slides: Option<bool>,
    pub skip_empty_pages: Option<bool>,
    pub add_original_document_as_stream: Option<bool>,
    pub single_page_sheets: Option<bool>,
    pub lossless_image_compression: Option<bool>,
    pub quality: Option<u8>,
    pub reduce_image_resolution: Option<bool>,
    pub max_image_resolution: Option<u32>,
    pub pdfa: Option<PDFFormat>,
    pub pdfua: Option<bool>,
}

Options for converting a document to a PDF using the LibreOffice engine.

Fields

trace_id: Option<String>

By default, the API assigns a unique UUID trace to every request. However, you also have the option to specify the trace for each request. This trace will show up on the end server as a Gotenberg-Trace header.

password: Option<String>

Set the password for opening the source file.

landscape: Option<bool>

Set the paper orientation to landscape. default: false

native_page_ranges: Option<PageRange>

Page ranges to print, e.g., ‘1-4’ - empty means all pages. default: All pages

export_form_fields: Option<bool>

Specify whether form fields are exported as widgets or only their fixed print representation is exported. default: true

allow_duplicate_field_names: Option<bool>

Specify whether multiple form fields exported are allowed to have the same field name. default: false

export_bookmarks: Option<bool>

Specify if bookmarks are exported to PDF. default: true

export_bookmarks_to_pdf_destination: Option<bool>

Specify that the bookmarks contained in the source LibreOffice file should be exported to the PDF file as Named Destination. default: false

export_placeholders: Option<bool>

Export the placeholders fields visual markings only. The exported placeholder is ineffective. default: false

export_notes: Option<bool>

Specify if notes are exported to PDF. default: false

export_notes_pages: Option<bool>

Specify if notes pages are exported to PDF. Notes pages are available in Impress documents only. default: false

export_only_notes_pages: Option<bool>

Specify, if the form field exportNotesPages is set to true, if only notes pages are exported to PDF. default: false

export_notes_in_margin: Option<bool>

Specify if notes in margin are exported to PDF. default: false

convert_ooo_target_to_pdf_target: Option<bool>

Specify that the target documents with .od[tpgs] extension, will have that extension changed to .pdf when the link is exported to PDF. The source document remains untouched. default: false

export_links_relative_fsys: Option<bool>

Specify that the file system related hyperlinks (file:// protocol) present in the document will be exported as relative to the source document location. default: false

export_hidden_slides: Option<bool>

Export, for LibreOffice Impress, slides that are not included in slide shows. default: false

skip_empty_pages: Option<bool>

Specify that automatically inserted empty pages are suppressed. This option is active only if storing Writer documents. default: false

add_original_document_as_stream: Option<bool>

Specify that a stream is inserted to the PDF file which contains the original document for archiving purposes. default: false

single_page_sheets: Option<bool>

Ignore each sheet’s paper size, print ranges and shown/hidden status and puts every sheet (even hidden sheets) on exactly one page. default: false

lossless_image_compression: Option<bool>

Specify if images are exported to PDF using a lossless compression format like PNG or compressed using the JPEG format. default: false

quality: Option<u8>

Specify the quality of the JPG export. A higher value produces a higher-quality image and a larger file. Between 1 and 100. default: 90

reduce_image_resolution: Option<bool>

Specify if the resolution of each image is reduced to the resolution specified by the form field maxImageResolution. default: false

max_image_resolution: Option<u32>

If the form field reduceImageResolution is set to true, tell if all images will be reduced to the given value in DPI. Possible values are: 75, 150, 300, 600 and 1200. default: 300

pdfa: Option<PDFFormat>

Convert the resulting PDF into the given PDF/A format

pdfua: Option<bool>

Enable PDF for Universal Access for optimal accessibility.

Trait Implementations

impl Clone for DocumentOptions

fn clone(&self) -> DocumentOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentOptions

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

Formats the value using the given formatter.

impl Default for DocumentOptions

fn default() -> DocumentOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DocumentOptions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DocumentOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.