PdfBuilder

Struct PdfBuilder 

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

Builder for generating PDFs.

Implementations§

Source§

impl<'a> PdfBuilder<'a>

Source

pub fn format(self, format: PaperFormat) -> Self

Set the paper format.

Source

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

Set landscape orientation.

Source

pub fn margins(self, margins: Margins) -> Self

Set the margins.

Source

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

Set all margins to the same value (in inches).

Source

pub fn margin_all(self, top: f64, right: f64, bottom: f64, left: f64) -> Self

Set each margin individually (in inches).

Source

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

Set the scale factor (0.1 to 2.0).

Source

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

Print background graphics.

Source

pub fn header_template(self, template: impl Into<String>) -> Self

Set the header template HTML.

The template can use special classes:

  • date: current date
  • title: document title
  • url: document URL
  • pageNumber: current page number
  • totalPages: total pages
Source

pub fn footer_template(self, template: impl Into<String>) -> Self

Set the footer template HTML.

Uses the same special classes as the header template.

Source

pub fn page_ranges(self, ranges: impl Into<String>) -> Self

Set page ranges (e.g., “1-5, 8, 11-13”).

Source

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

Prefer CSS @page size over the specified format.

Source

pub fn path(self, path: impl AsRef<Path>) -> Self

Save the PDF to a file.

Source

pub async fn generate(self) -> Result<Vec<u8>, PageError>

Generate the PDF.

Returns the PDF as a byte buffer.

§Errors

Returns an error if:

  • The page is closed
  • The CDP command fails
  • File saving fails (if a path was specified)

Trait Implementations§

Source§

impl<'a> Clone for PdfBuilder<'a>

Source§

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

Returns a duplicate 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<'a> Debug for PdfBuilder<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for PdfBuilder<'a>

§

impl<'a> !RefUnwindSafe for PdfBuilder<'a>

§

impl<'a> Send for PdfBuilder<'a>

§

impl<'a> Sync for PdfBuilder<'a>

§

impl<'a> Unpin for PdfBuilder<'a>

§

impl<'a> !UnwindSafe for PdfBuilder<'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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. 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