Struct LogCommand 

pub struct LogCommand {
    pub sub_command: Option<LogSubCommand>,
    pub dump: bool,
    pub set_severity: Vec<OneOrMany<LogInterestSelector>>,
    pub filters: LogFilterArgs,
}

Consolidated log command representation containing merged filter criteria and subcommands.

Fields

sub_command: Option<LogSubCommand>

dump: bool

set_severity: Vec<OneOrMany<LogInterestSelector>>

filters: LogFilterArgs

Implementations

impl LogCommand

pub fn merge_subcommand(&mut self)

Merges subcommand filter overrides (e.g. dump or watch) into self.filters.

impl LogCommand

pub fn severity(&self) -> Severity

Returns the minimum log severity.

pub fn clock(&self) -> TimeFormat

Returns the timestamp display format.

pub fn encoding(&self) -> LogEncoding

Returns the log encoding format.

pub fn filter(&self) -> &[String]

Returns the log text filter patterns.

pub fn moniker(&self) -> &[String]

Returns the deprecated moniker filter patterns.

pub fn component(&self) -> &[String]

Returns the component filter patterns.

pub fn exclude(&self) -> &[String]

Returns the text exclusion patterns.

pub fn exclude_regex(&self) -> &[String]

Returns the regular expression exclusion patterns.

pub fn tag(&self) -> &[String]

Returns the tag filter patterns.

pub fn exclude_tags(&self) -> &[String]

Returns the tag exclusion patterns.

pub fn hide_tags(&self) -> bool

Returns whether tags are hidden from output.

pub fn no_color(&self) -> bool

Returns whether colored output is disabled.

pub fn set_no_color(&mut self, no_color: bool)

Sets whether colored output is disabled.

pub fn show_metadata(&self) -> bool

Returns whether PID and TID metadata are displayed.

pub fn hide_file(&self) -> bool

Returns whether file and line number locations are hidden.

pub fn hide_moniker(&self) -> bool

Returns whether monikers are hidden from output.

pub fn show_full_moniker(&self) -> bool

Returns whether full monikers are displayed.

pub fn prefer_url_component_name(&self) -> bool

Returns whether component URL is preferred over moniker for display.

pub fn since(&self) -> Option<&DetailedDateTime>

Returns the starting timestamp filter.

pub fn until(&self) -> Option<&DetailedDateTime>

Returns the ending timestamp filter.

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

Returns the starting boot duration filter.

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

Returns the ending boot duration filter.

pub fn json(&self) -> bool

Returns whether JSON output is enabled.

pub fn exclude_regex_file(&self) -> Option<&str>

Returns the path to the regex exclusion file, if set.

pub fn kernel(&self) -> bool

Returns whether only kernel logs should be displayed.

pub fn force_set_severity(&self) -> bool

Returns whether severity selectors bypass ambiguity checks.

pub fn case_sensitive(&self) -> bool

Returns whether text filtering is case-sensitive.

pub fn pid(&self) -> Option<u64>

Returns the process ID filter, if set.

pub fn tid(&self) -> Option<u64>

Returns the thread ID filter, if set.

pub fn validate_cmd_flags_with_warnings( &mut self, ) -> Result<Vec<&'static str>, LogError>

pub async fn maybe_set_interest( &self, log_settings_client: &LogSettingsProxy, realm_query: &impl InstanceGetter, ) -> Result<(), LogError>

Sets interest based on configured selectors. If a single ambiguous match is found, the monikers in the selectors are automatically re-written.

Trait Implementations

impl ArgsInfo for LogCommand

fn get_args_info() -> CommandInfoWithArgs

Returns the argument info.

fn get_subcommands() -> Vec<SubCommandInfo<'static>>

Returns the list of subcommands

impl Clone for LogCommand

fn clone(&self) -> LogCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LogCommand

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

Formats the value using the given formatter.

impl Default for LogCommand

fn default() -> LogCommand

Returns the “default value” for a type.

impl FromArgs for LogCommand

fn from_args(command_name: &[&str], args: &[&str]) -> Result<Self, EarlyExit>

Construct the type from an input set of arguments.

fn redact_arg_values( _command_name: &[&str], _args: &[&str], ) -> Result<Vec<String>, EarlyExit>

Get a String with just the argument names, e.g., options, flags, subcommands, etc, but without the values of the options and arguments. This can be useful as a means to capture anonymous usage statistics without revealing the content entered by the end user.

impl PartialEq for LogCommand

fn eq(&self, other: &LogCommand) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for LogCommand

impl SubCommand for LogCommand

const COMMAND: &'static CommandInfo = RawLogCommand::COMMAND

Information about the subcommand.

impl TopLevelCommand for LogCommand