Struct CliArgs 

pub struct CliArgs {

    pub base_pdf: Option<PathBuf>,
    pub tailored_pdf: Option<PathBuf>,
    pub output: Option<PathBuf>,
    pub force: bool,
    pub open: bool,
    pub theme: ThemeKind,
    pub granularity: DiffGranularity,
    pub gutter_width: f32,
    pub no_header: bool,
    pub max_pages: usize,
    pub verbose: bool,
    pub generate_completions: Option<Shell>,
    pub generate_man: bool,
}

CLI arguments for pdf-vdiff.

Fields

base_pdf: Option<PathBuf>

Path to the original / base PDF document

tailored_pdf: Option<PathBuf>

Path to the modified / tailored PDF document

output: Option<PathBuf>

Target output PDF file path [default: <base_stem>vs<tailored_stem>_diff.pdf]

force: bool

Overwrite destination output file if it already exists

open: bool

Automatically open the generated diff in the system default PDF viewer

theme: ThemeKind

Color palette theme (intellij, github, classic, high-contrast)

granularity: DiffGranularity

Diff granularity mode (word, line, character)

gutter_width: f32

Spacing in points between left and right pages

no_header: bool

Suppress the top header/metadata banner

max_pages: usize

Maximum page count threshold to prevent unbounded processing

verbose: bool

Enable verbose structural logging (omits sensitive raw text PII)

generate_completions: Option<Shell>

Generate shell completion script to stdout (bash, zsh, fish, elvish, powershell)

generate_man: bool

Generate roff man page (Section 1) to stdout

Implementations

impl CliArgs

pub fn resolve_output_path(&self) -> PathBuf

Resolves the effective output path, defaulting to <base_stem>_vs_<tailored_stem>_diff.pdf.

pub fn effective_header_height(&self) -> f32

Header height in points taking --no-header flag into account.

Trait Implementations

impl Args for CliArgs

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 via FromArgMatches::from_arg_matches_mut

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

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl Clone for CliArgs

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommandFactory for CliArgs

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 CliArgs

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

Formats the value using the given formatter.

impl FromArgMatches for CliArgs

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 CliArgs

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.