Skip to main content

PrintToPDFParams

Struct PrintToPDFParams 

Source
pub struct PrintToPDFParams<'a> { /* private fields */ }
Expand description

Print page as PDF.

Implementations§

Source§

impl<'a> PrintToPDFParams<'a>

Source

pub fn builder() -> PrintToPDFParamsBuilder<'a>

Creates a builder for this type.

Source

pub fn landscape(&self) -> Option<bool>

Paper orientation. Defaults to false.

Display header and footer. Defaults to false.

Source

pub fn print_background(&self) -> Option<bool>

Print background graphics. Defaults to false.

Source

pub fn scale(&self) -> Option<f64>

Scale of the webpage rendering. Defaults to 1.

Source

pub fn paper_width(&self) -> Option<f64>

Paper width in inches. Defaults to 8.5 inches.

Source

pub fn paper_height(&self) -> Option<f64>

Paper height in inches. Defaults to 11 inches.

Source

pub fn margin_top(&self) -> Option<f64>

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

Source

pub fn margin_bottom(&self) -> Option<f64>

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

Source

pub fn margin_left(&self) -> Option<f64>

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

Source

pub fn margin_right(&self) -> Option<f64>

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

Source

pub fn page_ranges(&self) -> Option<&str>

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) -> Option<&str>

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) -> Option<&str>

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

Source

pub fn prefer_css_page_size(&self) -> Option<bool>

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) -> Option<&str>

return as stream

Source

pub fn generate_tagged_pdf(&self) -> Option<bool>

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

Source

pub fn generate_document_outline(&self) -> Option<bool>

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

Source§

impl<'a> PrintToPDFParams<'a>

Source

pub const METHOD: &'static str = "Page.printToPDF"

Trait Implementations§

Source§

impl<'a> CdpCommand<'a> for PrintToPDFParams<'a>

Source§

const METHOD: &'static str = "Page.printToPDF"

Source§

type Response = PrintToPDFReturns<'a>

Source§

impl<'a> Clone for PrintToPDFParams<'a>

Source§

fn clone(&self) -> PrintToPDFParams<'a>

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<'a> Debug for PrintToPDFParams<'a>

Source§

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

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

impl<'a> Default for PrintToPDFParams<'a>

Source§

fn default() -> PrintToPDFParams<'a>

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

impl<'de, 'a> Deserialize<'de> for PrintToPDFParams<'a>

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<'a> Serialize for PrintToPDFParams<'a>

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for PrintToPDFParams<'a>

§

impl<'a> RefUnwindSafe for PrintToPDFParams<'a>

§

impl<'a> Send for PrintToPDFParams<'a>

§

impl<'a> Sync for PrintToPDFParams<'a>

§

impl<'a> Unpin for PrintToPDFParams<'a>

§

impl<'a> UnsafeUnpin for PrintToPDFParams<'a>

§

impl<'a> UnwindSafe for PrintToPDFParams<'a>

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> 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 = 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.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,