Struct broot::verb::ExternalExecution

pub struct ExternalExecution {
    pub exec_pattern: String,
    pub exec_mode: ExternalExecutionMode,
    pub arg_selection_type: Option<SelectionType>,
    pub arg_anchor: PathAnchor,
    pub need_another_panel: bool,
    // some fields omitted
}

Definition of how the user input should be interpreted to be executed in an external command.

Fields

exec_pattern: String

the pattern which will result in an exectuable string when completed with the args

exec_mode: ExternalExecutionMode

how the external process must be launched

arg_selection_type: Option<SelectionType>

contain the type of selection in case there's only one arg and it's a path (when it's not None, the user can type ctrl-P to select the argument in another panel)

arg_anchor: PathAnchor

need_another_panel: bool

Implementations

impl ExternalExecution

pub fn new(
    invocation_str: &str,
    execution_str: &str,
    exec_mode: ExternalExecutionMode
) -> Result<Self, ConfError>

pub fn name(&self) -> &str

pub fn check_args(
    &self,
    invocation: &VerbInvocation,
    other_path: &Option<PathBuf>
) -> Option<String>

Assuming the verb has been matched, check whether the arguments are OK according to the regex. Return none when there's no problem and return the error to display if arguments don't match

pub fn to_cmd_result(
    &self,
    w: &mut W,
    sel: Selection,
    other_file: &Option<PathBuf>,
    args: &Option<String>,
    con: &AppContext
) -> Result<AppStateCmdResult, ProgramError>

pub fn shell_exec_string(
    &self,
    sel: Selection,
    other_file: &Option<PathBuf>,
    args: &Option<String>
) -> String

build a shell compatible command, with escapings

Trait Implementations

impl Clone for ExternalExecution

fn clone(&self) -> ExternalExecution

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExternalExecution

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

Formats the value using the given formatter.

impl From<ExternalExecution> for Verb

fn from(external_exec: ExternalExecution) -> Self

Performs the conversion.