Skip to main content

PrintToPDFParamsBuilder

Struct PrintToPDFParamsBuilder 

Source
pub struct PrintToPDFParamsBuilder<'a> { /* private fields */ }

Implementations§

Source§

impl<'a> PrintToPDFParamsBuilder<'a>

Source

pub fn landscape(self, landscape: bool) -> Self

Paper orientation. Defaults to false.

Display header and footer. Defaults to false.

Source

pub fn print_background(self, print_background: bool) -> Self

Print background graphics. Defaults to false.

Source

pub fn scale(self, scale: f64) -> Self

Scale of the webpage rendering. Defaults to 1.

Source

pub fn paper_width(self, paper_width: f64) -> Self

Paper width in inches. Defaults to 8.5 inches.

Source

pub fn paper_height(self, paper_height: f64) -> Self

Paper height in inches. Defaults to 11 inches.

Source

pub fn margin_top(self, margin_top: f64) -> Self

Top margin in inches. Defaults to 1cm (~0.4 inches).

Source

pub fn margin_bottom(self, margin_bottom: f64) -> Self

Bottom margin in inches. Defaults to 1cm (~0.4 inches).

Source

pub fn margin_left(self, margin_left: f64) -> Self

Left margin in inches. Defaults to 1cm (~0.4 inches).

Source

pub fn margin_right(self, margin_right: f64) -> Self

Right margin in inches. Defaults to 1cm (~0.4 inches).

Source

pub fn page_ranges(self, page_ranges: impl Into<Cow<'a, str>>) -> Self

Paper ranges to print, one based, e.g., ‘1-5, 8, 11-13’. Pages are printed in the document order, not in the order specified, and no more than once. Defaults to empty string, which implies the entire document is printed. The page numbers are quietly capped to actual page count of the document, and ranges beyond the end of the document are ignored. If this results in no pages to print, an error is reported. It is an error to specify a range with start greater than end.

Source

pub fn header_template(self, header_template: impl Into<Cow<'a, str>>) -> Self

HTML template for the print header. Should be valid HTML markup with following classes used to inject printing values into them:

  • ‘date’: formatted print date
  • ‘title’: document title
  • ‘url’: document location
  • ‘pageNumber’: current page number
  • ‘totalPages’: total pages in the document

For example, ‘<span class=title></span>’ would generate span containing the title.

Source

pub fn footer_template(self, footer_template: impl Into<Cow<'a, str>>) -> Self

HTML template for the print footer. Should use the same format as the ‘headerTemplate’.

Source

pub fn prefer_css_page_size(self, prefer_css_page_size: bool) -> Self

Whether or not to prefer page size as defined by css. Defaults to false, in which case the content will be scaled to fit the paper size.

Source

pub fn transfer_mode(self, transfer_mode: impl Into<Cow<'a, str>>) -> Self

return as stream

Source

pub fn generate_tagged_pdf(self, generate_tagged_pdf: bool) -> Self

Whether or not to generate tagged (accessible) PDF. Defaults to embedder choice.

Source

pub fn generate_document_outline(self, generate_document_outline: bool) -> Self

Whether or not to embed the document outline into the PDF.

Source

pub fn build(self) -> PrintToPDFParams<'a>

Trait Implementations§

Source§

impl<'a> Default for PrintToPDFParamsBuilder<'a>

Source§

fn default() -> PrintToPDFParamsBuilder<'a>

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

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> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.