Struct ActiveHelp 

pub struct ActiveHelp {
    pub message: String,
    pub condition: Option<Arc<ConditionFn>>,
}

Represents an ActiveHelp message with optional condition

Fields

message: String

The help message to display

condition: Option<Arc<ConditionFn>>

Optional condition that must be true for this help to be shown

Implementations

impl ActiveHelp

pub fn new<S: Into<String>>(message: S) -> Self

Creates a new ActiveHelp message without condition

Examples

use flag_rs::active_help::ActiveHelp;

let help = ActiveHelp::new("Use TAB to see available options");

pub fn with_condition<S, F>(message: S, condition: F) -> Self

where S: Into<String>, F: Fn(&Context) -> bool + Send + Sync + 'static,

Creates a new ActiveHelp message with a condition

The help will only be shown when the condition returns true.

Examples

use flag_rs::active_help::ActiveHelp;

let help = ActiveHelp::with_condition(
    "Tip: Use -n <namespace> to filter results",
    |ctx| ctx.flag("namespace").is_none()
);

pub fn should_display(&self, ctx: &Context) -> bool

Checks if this help should be displayed given the current context

Trait Implementations

impl Clone for ActiveHelp

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ActiveHelp

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

Formats the value using the given formatter.