Struct BriefArgs 

pub struct BriefArgs {
    pub repo: RepoArgs,
    pub line: bool,
    pub keep_awake: bool,
    pub session: Option<String>,
    pub this_checkout: bool,
    pub format: OutputFormat,
}

majordomus brief: the brief.session capability on the command line (ADR 0136).

Example

use majordomus_cli::cli::{BriefArgs, Cli, Command, OutputFormat};
use clap::Parser;
let cli = Cli::try_parse_from(["majordomus", "brief", "--line", "--session", "abc"]).unwrap();
let Command::Brief(args) = cli.command else { panic!("not the brief command") };
let args: BriefArgs = args;
assert!(args.line && !args.keep_awake && !args.this_checkout);
assert_eq!(args.session.as_deref(), Some("abc"));
assert!(matches!(args.format, OutputFormat::Text));

Fields

repo: RepoArgs

Where and how the repository is read.

line: bool

Print the one-line brief alone: the status line’s text

keep_awake: bool

Print what a session is told at its start about keeping itself awake, then the one-line brief

session: Option<String>

The provider’s own session identity: the brief names the open episode it owns

this_checkout: bool

Read this checkout’s board alone instead of every checkout’s

format: OutputFormat

Output shape

Trait Implementations

impl Args for BriefArgs

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::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 Debug for BriefArgs

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

Formats the value using the given formatter.

impl FromArgMatches for BriefArgs

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.