Struct html2pdf::Options

pub struct Options {
    pub input: PathBuf,
    pub output: Option<PathBuf>,
    pub landscape: bool,
    pub background: bool,
    pub wait: Option<Duration>,
    pub header: Option<String>,
    pub footer: Option<String>,
    pub paper: Option<PaperSize>,
    pub scale: Option<f64>,
    pub range: Option<String>,
    pub margin: Option<Margin>,
    pub disable_sandbox: bool,
}

Generate a PDF from a local HTML file using a headless chrome

Fields

input: PathBuf

Input HTML file.

output: Option<PathBuf>

Output file. By default, just change the input extension to PDF

landscape: bool

Use landscape mode.

background: bool

Allow print background.

wait: Option<Duration>

Time to wait in ms before printing. Examples: 150ms, 10s

header: Option<String>

HTML template for the print header. Should be valid HTML markup with following classes used to inject printing values into them: date for formatted print date, title for document title, url for document location, pageNumber for current page number, totalPages for total pages in the document. For example, <span class=title></span> would generate span containing the title.

footer: Option<String>

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

paper: Option<PaperSize>

Paper size. Supported values: A4, Letter, A3, Tabloid, A2, A1, A0, A5, A6

scale: Option<f64>

Scale, default to 1.0

range: Option<String>

Paper ranges to print, e.g. ‘1-5, 8, 11-13’

margin: Option<Margin>

Margin in inches You can define margin like this: ‘0.4’ the value is applied for all side, ‘0.4 0.4’ : first value is applied for top and bottom, second for left and right, ‘0.4 0.4 0.4 0.4’ : first value is applied for top then, right, then bottom, and last for left

disable_sandbox: bool

Disable Chrome sandbox Not recommended, unless running on docker

Implementations

impl Options

pub fn input(&self) -> &PathBuf

Get a reference to the cli options’s input.

pub fn output(&self) -> Option<&PathBuf>

Get a reference to the cli options’s output.

pub fn landscape(&self) -> bool

Get a reference to the cli options’s landscape.

pub fn background(&self) -> bool

Get a reference to the cli options’s background.

pub fn wait(&self) -> Option<Duration>

Get a reference to the cli options’s wait.

pub fn header(&self) -> Option<&String>

Get a reference to the cli options’s header.

pub fn footer(&self) -> Option<&String>

Get a reference to the cli options’s footer.

pub fn paper(&self) -> Option<&PaperSize>

Get a reference to the cli options’s paper.

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

Get a reference to the cli options’s scale.

pub fn margin(&self) -> Option<&Margin>

Get a reference to the cli options’s margin.

pub fn range(&self) -> Option<&String>

Get a reference to the cli options’s range.

pub fn disable_sandbox(&self) -> bool

Get a reference to the cli options’s sandbox.

Trait Implementations

impl Args for Options

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self.

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can update self.

impl CommandFactory for Options

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for Options

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

Formats the value using the given formatter.

impl From<&Options> for LaunchOptions<'_>

fn from(opt: &Options) -> Self

Converts to this type from the input type.

impl From<&Options> for PrintToPdfOptions

fn from(opt: &Options) -> Self

Converts to this type from the input type.

impl FromArgMatches for Options

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for Options

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.