Struct CommandHelper

pub struct CommandHelper { /* private fields */ }

Implementations

impl CommandHelper

pub fn app(&self) -> &Command

pub fn cwd(&self) -> &Path

Canonical form of the current working directory path.

A loaded Workspace::workspace_root() also returns a canonical path, so relative paths can be easily computed from these paths.

pub fn string_args(&self) -> &Vec<String>

pub fn matches(&self) -> &ArgMatches

pub fn global_args(&self) -> &GlobalArgs

pub fn settings(&self) -> &UserSettings

pub fn resolved_config_values( &self, prefix: &ConfigNamePathBuf, ) -> Result<Vec<AnnotatedValue>, ConfigError>

pub fn revset_extensions(&self) -> &Arc<RevsetExtensions>

pub fn parse_template<'a, C: Clone + 'a, L: TemplateLanguage<'a> + ?Sized>( &self, ui: &Ui, language: &L, template_text: &str, wrap_self: impl Fn(PropertyPlaceholder<C>) -> L::Property, ) -> Result<TemplateRenderer<'a, C>, CommandError>

Parses template of the given language into evaluation tree.

This function also loads template aliases from the settings. Use WorkspaceCommandHelper::parse_template() if you’ve already instantiated the workspace helper.

pub fn workspace_loader(&self) -> Result<&dyn WorkspaceLoader, CommandError>

pub fn workspace_helper( &self, ui: &Ui, ) -> Result<WorkspaceCommandHelper, CommandError>

Loads workspace and repo, then snapshots the working copy if allowed.

pub fn workspace_helper_no_snapshot( &self, ui: &Ui, ) -> Result<WorkspaceCommandHelper, CommandError>

Loads workspace and repo, but never snapshots the working copy. Most commands should use workspace_helper() instead.

pub fn get_working_copy_factory( &self, ) -> Result<&dyn WorkingCopyFactory, CommandError>

pub fn load_workspace(&self) -> Result<Workspace, CommandError>

pub fn workspace_environment( &self, ui: &Ui, workspace: &Workspace, ) -> Result<WorkspaceCommandEnvironment, CommandError>

Loads command environment for the given workspace.

pub fn is_working_copy_writable(&self) -> bool

Returns true if the working copy to be loaded is writable, and therefore should usually be snapshotted.

pub fn is_at_head_operation(&self) -> bool

Returns true if the current operation is considered to be the head.

pub fn resolve_operation( &self, ui: &Ui, repo_loader: &RepoLoader, ) -> Result<Operation, CommandError>

Resolves the current operation from the command-line argument.

If no --at-operation is specified, the head operations will be loaded. If there are multiple heads, they’ll be merged.

pub fn for_workable_repo( &self, ui: &Ui, workspace: Workspace, repo: Arc<ReadonlyRepo>, ) -> Result<WorkspaceCommandHelper, CommandError>

Creates helper for the repo whose view is supposed to be in sync with the working copy. If --ignore-working-copy is not specified, the returned helper will attempt to update the working copy.

Trait Implementations

impl Clone for CommandHelper

fn clone(&self) -> CommandHelper

Returns a copy of the value.

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

Performs copy-assignment from source.