Struct Cli 

pub struct Cli {

    pub screenshot: bool,
    pub portal: bool,
    pub list_windows: bool,
    pub list_displays: bool,
    pub list_apps: bool,
    pub preflight: bool,
    pub request_permission: bool,
    pub window_id: Option<u32>,
    pub app: Option<String>,
    pub window_name: Option<String>,
    pub active_window: bool,
    pub display: bool,
    pub display_id: Option<u32>,
    pub duration: Option<u64>,
    pub audio: AudioMode,
    pub path: Option<PathBuf>,
    pub metadata_out: Option<PathBuf>,
    pub diagnostics_out: Option<PathBuf>,
    pub format: Option<ContainerFormat>,
    pub image_format: Option<ImageFormat>,
    pub dir: Option<PathBuf>,
    pub if_changed: bool,
    pub if_changed_baseline: Option<PathBuf>,
    pub if_changed_threshold: Option<u32>,
}

Fields

screenshot: bool

Capture a single window screenshot and exit.

portal: bool

Use the system portal picker (Linux Wayland) instead of X11 selectors.

list_windows: bool

Print selectable windows as TSV and exit.

list_displays: bool

Print selectable displays as TSV and exit.

list_apps: bool

Print selectable apps as TSV and exit.

preflight: bool

Check capture prerequisites (macOS permission or X11/ffmpeg availability) and exit.

request_permission: bool

Best-effort permission request (macOS) or prerequisite check (X11), then exit.

window_id: Option<u32>

Record a specific window id (from –list-windows).

app: Option<String>

Select a window by app/owner name (case-insensitive substring).

window_name: Option<String>

Narrow –app selection by window title substring.

active_window: bool

Record the frontmost window on the current Space.

display: bool

Record the primary display.

display_id: Option<u32>

Record a specific display id (from –list-displays).

duration: Option<u64>

Record for N seconds.

audio: AudioMode

Control audio capture.

path: Option<PathBuf>

Output file path.

metadata_out: Option<PathBuf>

Write recording metadata JSON to this path.

diagnostics_out: Option<PathBuf>

Write diagnostics manifest JSON and sidecar artifacts for recording mode.

format: Option<ContainerFormat>

Explicit container selection. Overrides extension.

image_format: Option<ImageFormat>

Screenshot output image format. Overrides extension.

dir: Option<PathBuf>

Output directory for screenshot mode when –path is omitted.

if_changed: bool

Skip publishing a new screenshot when the capture hash stays within threshold.

if_changed_baseline: Option<PathBuf>

Optional baseline image path for –if-changed comparisons.

if_changed_threshold: Option<u32>

Maximum allowed hash-distance bits before capture is considered changed.

Trait Implementations

impl Args for Cli

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 Cli

fn clone(&self) -> Cli

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommandFactory for Cli

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 Cli

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

Formats the value using the given formatter.

impl FromArgMatches for Cli

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 Cli

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.