Struct PdfOptions 

pub struct PdfOptions {

    pub path: Option<PathBuf>,
    pub scale: Option<f64>,
    pub display_header_footer: Option<bool>,
    pub header_template: Option<String>,
    pub footer_template: Option<String>,
    pub print_background: Option<bool>,
    pub landscape: Option<bool>,
    pub page_ranges: Option<String>,
    pub format: Option<String>,
    pub width: Option<String>,
    pub height: Option<String>,
    pub prefer_css_page_size: Option<bool>,
    pub margin: Option<PdfMargin>,
}

Options for generating a PDF from a page.

Note: PDF generation is only supported by Chromium. Calling page.pdf() on Firefox or WebKit will result in an error.

See: https://playwright.dev/docs/api/class-page#page-pdf

Fields

path: Option<PathBuf>

If specified, the PDF will also be saved to this file path.

scale: Option<f64>

Scale of the webpage rendering, between 0.1 and 2 (default 1).

display_header_footer: Option<bool>

Whether to display header and footer (default false).

header_template: Option<String>

HTML template for the print header. Should be valid HTML.

footer_template: Option<String>

HTML template for the print footer.

print_background: Option<bool>

Whether to print background graphics (default false).

landscape: Option<bool>

Paper orientation — true for landscape (default false).

page_ranges: Option<String>

Paper ranges to print, e.g. "1-5, 8". Defaults to empty string (all pages).

format: Option<String>

Paper format, e.g. "Letter" or "A4". Overrides width/height.

width: Option<String>

Paper width in CSS units, e.g. "8.5in". Overrides format.

height: Option<String>

Paper height in CSS units, e.g. "11in". Overrides format.

prefer_css_page_size: Option<bool>

Whether or not to prefer page size as defined by CSS.

margin: Option<PdfMargin>

Paper margins, defaulting to none.

Implementations

impl PdfOptions

pub fn builder() -> PdfOptionsBuilder

Creates a new builder for PdfOptions

Trait Implementations

impl Clone for PdfOptions

fn clone(&self) -> PdfOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PdfOptions

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

Formats the value using the given formatter.

impl Default for PdfOptions

fn default() -> PdfOptions

Returns the “default value” for a type.