Struct JjCommandSpec 

pub struct JjCommandSpec { /* private fields */ }

A typed description of one jj command.

Implementations

impl JjCommandSpec

pub fn render_read_only( argv: impl IntoIterator<Item = impl Into<OsString>>, ) -> Self

Creates a read-only jj command spec from command arguments after the jj binary.

pub fn confirm_mutation( argv: impl IntoIterator<Item = impl Into<OsString>>, safety: SafetyClass, ) -> Self

Creates a jj command spec that must be previewed before mutation execution.

pub fn with_cwd(self, cwd: impl Into<PathBuf>) -> Self

Sets the process working directory metadata.

pub fn with_repository(self, repository: impl Into<PathBuf>) -> Self

Sets the repository path metadata.

pub fn with_global_options(self, global_options: GlobalOptions) -> Self

Sets the global jj options.

pub fn with_stdin(self, stdin: impl Into<String>) -> Self

Sets stdin text for a future command runner.

pub fn with_title(self, title: impl Into<String>) -> Self

Sets the display title independently from the executable argv.

pub const fn with_mode(self, mode: ExecutionMode) -> Self

Sets the execution mode.

pub const fn with_safety(self, safety: SafetyClass) -> Self

Sets the safety class.

pub const fn with_refresh_plan(self, refresh_plan: RefreshPlan) -> Self

Sets the refresh plan.

pub fn argv(&self) -> &[OsString]

Returns command arguments after the jj binary.

pub const fn global_options(&self) -> &GlobalOptions

Returns global jj options owned by the spec.

pub fn global_argv(&self) -> Vec<OsString>

Returns global jj arguments rendered before the command family.

pub fn process_argv(&self) -> Vec<OsString>

Returns process arguments after the jj binary.

pub fn cwd(&self) -> Option<&Path>

Returns the process working directory metadata.

pub fn repository(&self) -> Option<&Path>

Returns the repository path metadata.

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

Returns stdin text for a future command runner.

pub fn title(&self) -> &str

Returns the display title.

pub fn preview(&self) -> String

Returns a display-only command preview.

pub fn process_preview(&self) -> String

Returns a display-only process preview with global options before command arguments.

pub fn command_preview(&self) -> CommandPreview

Returns a command preview suitable for confirmation UI.

pub const fn mode(&self) -> ExecutionMode

Returns the execution mode.

pub const fn safety(&self) -> SafetyClass

Returns the safety class.

pub const fn refresh_plan(&self) -> RefreshPlan

Returns the refresh plan.

Trait Implementations

impl Clone for JjCommandSpec

fn clone(&self) -> JjCommandSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JjCommandSpec

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

Formats the value using the given formatter.

impl Eq for JjCommandSpec

impl PartialEq for JjCommandSpec

fn eq(&self, other: &JjCommandSpec) -> 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 JjCommandSpec