Struct Cli

pub struct Cli {
    pub monitors: Vec<Monitor>,
    pub backend: Option<String>,
    pub needs_capabilities: bool,
    pub dry_run: bool,
    pub verbose: u8,
    pub args: Vec<String>,
    /* private fields */
}

A command line tool to change display monitors’ input sources via DDC/CI.

Examples

fn run_cli(args: Vec<String>) -> anyhow::Result<()> {
    let mut cli = Cli::new();
    cli.args = args;
    cli.run()
}

To setup Cli from the command line arguments:

use clap::Parser;
use monitor_input::{Cli,Monitor};

fn main() -> anyhow::Result<()> {
    let mut cli = Cli::parse();
    cli.init_logger();
    cli.monitors = Monitor::enumerate();
    cli.run()
}

See https://github.com/kojiishi/monitor-input-rs for more details.

Fields

monitors: Vec<Monitor>

The list of Monitors to run the command line tool on. This field is usually initialized to Monitor::enumerate().

backend: Option<String>

Filter by the backend name.

needs_capabilities: bool

Get capabilities from the display monitors.

dry_run: bool

Dry-run (prevent actual changes).

verbose: u8

Show verbose information.

args: Vec<String>

name to search, name=input to change the input source, or name=input1,input2 to toggle.

Implementations

impl Cli

pub fn new() -> Self

Construct an instance with display monitors from Monitor::enumerate().

pub fn init_logger(&self)

👎Deprecated since 1.2.1: To remove loggers from the lib. Please setup your favorite logger.

Initialize the logging. The configurations depend on Cli::verbose.

pub fn run(&mut self) -> Result<()>

Run the command line tool.

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 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 Default for Cli

fn default() -> Cli

Returns the “default value” for a type.

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.