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 config_env(&self) -> &ConfigEnv

pub fn raw_config(&self) -> &RawConfig

Unprocessed (or unresolved) configuration data.

Use this only if the unmodified config data is needed. For example, jj config set should use this to write updated data back to file.

pub fn settings(&self) -> &UserSettings

Settings for the current command and workspace.

This may be different from the settings for new workspace created by e.g. jj git init. There may be conditional variables and repo config .jj/repo/config.toml loaded for the cwd workspace.

pub fn settings_for_new_workspace( &self, workspace_root: &Path, ) -> Result<UserSettings, CommandError>

Resolves configuration for new workspace located at the specified path.

pub fn text_editor(&self) -> Result<TextEditor, ConfigGetError>

Loads text editor from the settings.

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

pub fn parse_template<'a, C, L>( &self, ui: &Ui, language: &L, template_text: &str, ) -> Result<TemplateRenderer<'a, C>, CommandError>

where C: Clone + 'a, L: TemplateLanguage<'a> + ?Sized, L::Property: WrapTemplateProperty<'a, C>,

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_with_stats( &self, ui: &Ui, ) -> Result<(WorkspaceCommandHelper, SnapshotStats), CommandError>

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

Note that unless you have a good reason not to do so, you should always call print_snapshot_stats with the SnapshotStats returned by this function to present possible untracked files to the user.

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>

Loads workspace for the current command.

pub fn load_workspace_at( &self, workspace_root: &Path, settings: &UserSettings, ) -> Result<Workspace, CommandError>

Loads workspace located at the specified path.

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

Note that unless you have a good reason not to do so, you should always call print_snapshot_stats with the SnapshotStats returned by this function to present possible untracked files to the user.

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 duplicate of the value.

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

Performs copy-assignment from source.