chromiumoxide::cdp::browser_protocol::page

Struct PrintToPdfParams

Source
pub struct PrintToPdfParams {
Show 17 fields pub landscape: Option<bool>, pub display_header_footer: Option<bool>, pub print_background: Option<bool>, pub scale: Option<f64>, pub paper_width: Option<f64>, pub paper_height: Option<f64>, pub margin_top: Option<f64>, pub margin_bottom: Option<f64>, pub margin_left: Option<f64>, pub margin_right: Option<f64>, pub page_ranges: Option<String>, pub header_template: Option<String>, pub footer_template: Option<String>, pub prefer_css_page_size: Option<bool>, pub transfer_mode: Option<PrintToPdfTransferMode>, pub generate_tagged_pdf: Option<bool>, pub generate_document_outline: Option<bool>,
}
Expand description

Print page as PDF. printToPDF

Fields§

§landscape: Option<bool>

Paper orientation. Defaults to false.

§display_header_footer: Option<bool>

Display header and footer. Defaults to false.

§print_background: Option<bool>

Print background graphics. Defaults to false.

§scale: Option<f64>

Scale of the webpage rendering. Defaults to 1.

§paper_width: Option<f64>

Paper width in inches. Defaults to 8.5 inches.

§paper_height: Option<f64>

Paper height in inches. Defaults to 11 inches.

§margin_top: Option<f64>

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

§margin_bottom: Option<f64>

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

§margin_left: Option<f64>

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

§margin_right: Option<f64>

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

§page_ranges: Option<String>

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.

§header_template: Option<String>

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.

§footer_template: Option<String>

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

§prefer_css_page_size: 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.

§transfer_mode: Option<PrintToPdfTransferMode>

return as stream

§generate_tagged_pdf: Option<bool>

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

§generate_document_outline: Option<bool>

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

Implementations§

Trait Implementations§

Source§

impl Clone for PrintToPdfParams

Source§

fn clone(&self) -> PrintToPdfParams

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Command for PrintToPdfParams

Source§

type Response = PrintToPdfReturns

The type of the response this request triggers on the chromium server
Source§

fn response_from_value(response: Value) -> Result<Self::Response, Error>

deserialize the response from json
Source§

impl Debug for PrintToPdfParams

Source§

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

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

impl Default for PrintToPdfParams

Source§

fn default() -> PrintToPdfParams

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

impl<'de> Deserialize<'de> for PrintToPdfParams

Source§

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

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

impl Method for PrintToPdfParams

Source§

fn identifier(&self) -> Cow<'static, str>

The whole string identifier for this method like: DOM.removeNode
Source§

fn domain_name(&self) -> Cow<'static, str>

The name of the domain this method belongs to: DOM
Source§

fn method_name(&self) -> Cow<'static, str>

The standalone identifier of the method inside the domain: removeNode
Source§

fn split(&self) -> (Cow<'static, str>, Cow<'static, str>)

Tuple of (domain_name, method_name) : (DOM, removeNode)
Source§

impl MethodType for PrintToPdfParams

Source§

fn method_id() -> Cow<'static, str>

The identifier for this event’s method field
Source§

impl PartialEq for PrintToPdfParams

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for PrintToPdfParams

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for PrintToPdfParams

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, dst: *mut u8)

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

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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 = 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

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

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T