Struct Change 

pub struct Change<M = Unselected, P = Unselected, C = Unselected, S = Unselected> { /* private fields */ }

Type-safe builder for p4 change.

Create or edit a changelist specification.

The command p4 changelist is an alias for p4 change.

Syntax

p4 [g-opts] change [-s] [-f | -u] [[-O|-I] changelist]
p4 [g-opts] change -d [-f -s -O] changelist
p4 [g-opts] change -o [-s] [-f] [[-O|-I] changelist]
p4 [g-opts] change -i [-s] [-f | -u]
p4 [g-opts] change -t restricted | public [-U user] [-f|-u|-O|-I] changelist
p4 [g-opts] change -U user [-t restricted | public] [-f] changelist
p4 [g-opts] change -d -f --serverid=X changelist

The four type parameters track, independently and at compile time:

• M: the command form — RegularOperationMode, DeleteMode, StdoutMode, StdinMode, or UserOrVisibilityMode;
• O: the -f / -u operation — ForceOperationMode, UpdateOperationMode, or the Only* variants used inside the -t / -U form;
• C: the -O / -I changelist reference — OriginalChangeListMode / IdentityChangeListMode, or their Only* variants;
• S: the -s arbitrary job status flag (ArbitraryJobStatus).

Start from Change::new (or crate::P4Cli::change), enter a form with one of Self::delete, Self::stdout, Self::stdin, Self::visibility, or Self::user (or one of the Self::force/Self::update/Self::original/ Self::identity/ Self::arbitrary_job_status entry points that select an option of the plain edit form), and move between compatible forms with the delete, stdout, stdin, visibility, user, and server_id transition methods.

Implementations

impl<O, C> Change<DeleteMode<LocalDeleteMode>, O, C, Unselected>

pub fn arbitrary_job_status( self, ) -> Change<DeleteMode<LocalDeleteMode>, O, C, ArbitraryJobStatus>

Selects -s in the delete form.

impl<C, S> Change<DeleteMode<LocalDeleteMode>, Unselected, C, S>

pub fn force( self, ) -> Change<DeleteMode<LocalDeleteMode>, ForceOperationMode, C, S>

Selects -f in the delete form (forcibly delete a submitted changelist).

impl<O, S> Change<DeleteMode<LocalDeleteMode>, O, Unselected, S>

pub fn original( self, ) -> Change<DeleteMode<LocalDeleteMode>, O, OriginalChangeListMode, S>

Selects -O in the delete form (reference by original changelist number).

impl<O: TransferRemoteDeleteMode> Change<DeleteMode<LocalDeleteMode>, O, Unselected, Unselected>

pub fn server_id( self, server_id: impl Into<String>, ) -> Change<DeleteMode<RemoteDeleteMode>, Unselected, Unselected, Unselected>

Transitions to the remote delete form.

Available from the local delete form as long as neither -s, -O, nor -u is selected (the remote delete form accepts no extra options; its -f is built in). A previously selected -f is simply dropped in favor of the built-in one.

server_id is the server id of the commit server the changelist’s client is bound to.

impl<O, C> Change<StdoutMode, O, C, Unselected>

pub fn arbitrary_job_status( self, ) -> Change<StdoutMode, O, C, ArbitraryJobStatus>

Selects -s in the stdout form.

impl<C, S> Change<StdoutMode, Unselected, C, S>

pub fn force(self) -> Change<StdoutMode, ForceOperationMode, C, S>

Selects -f in the stdout form.

impl<O, S> Change<StdoutMode, O, Unselected, S>

pub fn original(self) -> Change<StdoutMode, O, OriginalChangeListMode, S>

Selects -O in the stdout form (reference by original changelist number).

pub fn identity(self) -> Change<StdoutMode, O, IdentityChangeListMode, S>

Selects -I in the stdout form (reference by Identity field).

impl<O> Change<StdinMode, O, Unselected, Unselected>

pub fn arbitrary_job_status( self, ) -> Change<StdinMode, O, Unselected, ArbitraryJobStatus>

Selects -s in the stdin form.

impl<S> Change<StdinMode, Unselected, Unselected, S>

pub fn force(self) -> Change<StdinMode, ForceOperationMode, Unselected, S>

Selects -f in the stdin form.

pub fn update(self) -> Change<StdinMode, UpdateOperationMode, Unselected, S>

Selects -u in the stdin form.

impl<O, C> Change<UserOrVisibilityMode, O, C, Unselected>

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

Sets the new owner (-U user) of the changelist.

user is the user the changelist is transferred to.

pub fn set_user(&mut self, user: impl Into<String>) -> &mut Self

Sets the new owner (-U user) of the changelist.

user is the user the changelist is transferred to.

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

Returns the new owner (-U user) of the changelist, if set.

pub fn visibility(self, visibility: Visibility) -> Self

Sets the changelist visibility (-t restricted | public).

visibility selects the new changelist type.

pub fn set_visibility(&mut self, visibility: Visibility) -> &mut Self

Sets the changelist visibility (-t restricted | public).

visibility selects the new changelist type.

pub fn get_visibility(&self) -> Option<Visibility>

Returns the changelist visibility (-t restricted | public), if set.

impl Change<UserOrVisibilityMode, Unselected, Unselected, Unselected>

pub fn force( self, ) -> Change<UserOrVisibilityMode, OnlyForceOperationMode, Unselected, Unselected>

Selects -f (force the type/owner change).

Mutually exclusive with -u, -O, and -I.

pub fn update( self, ) -> Change<UserOrVisibilityMode, OnlyUpdateOperationMode, Unselected, Unselected>

Selects -u (update a submitted changelist).

Mutually exclusive with -f, -O, and -I.

pub fn original( self, ) -> Change<UserOrVisibilityMode, Unselected, OnlyOriginalChangeListMode, Unselected>

Selects -O: interpret the changelist number as the original, pre-renumber number.

Mutually exclusive with -f, -u, and -I.

pub fn identity( self, ) -> Change<UserOrVisibilityMode, Unselected, OnlyIdentityChangeListMode, Unselected>

Selects -I: interpret the changelist number as the Identity field.

Mutually exclusive with -f, -u, and -O.

impl Change<Unselected, Unselected, Unselected, Unselected>

pub fn new(bin: impl Into<PathBuf>, global_opts: GlobalOpts) -> Self

Creates a new p4 change command.

bin is the path to the Perforce command-line executable.

pub fn delete( self, ) -> Change<DeleteMode<LocalDeleteMode>, Unselected, Unselected, Unselected>

Enters the local delete form: p4 change -d changelist.

pub fn server_id( self, server_id: impl Into<String>, ) -> Change<DeleteMode<RemoteDeleteMode>, Unselected, Unselected, Unselected>

Enters the remote delete form.

-f is fixed in this form and is injected together with the form; none of the other options are accepted.

server_id is the server id of the commit server the changelist’s client is bound to.

pub fn stdout(self) -> Change<StdoutMode, Unselected, Unselected, Unselected>

Enters the stdout form: p4 change -o.

pub fn stdin(self) -> Change<StdinMode, Unselected, Unselected, Unselected>

Enters the stdin form: p4 change -i.

pub fn visibility( self, visibility: Visibility, ) -> Change<UserOrVisibilityMode, Unselected, Unselected, Unselected>

Enters the change-type form: p4 change -t restricted | public changelist.

visibility selects the new changelist type; the optional new owner can be added later with the user builder of the entered form.

pub fn user( self, user: impl Into<String>, ) -> Change<UserOrVisibilityMode, Unselected, Unselected, Unselected>

Enters the owner-transfer form: p4 change -U user changelist.

user is the new owner of the empty pending changelist; the optional visibility can be added later with the visibility builder of the entered form.

pub fn arbitrary_job_status( self, ) -> Change<RegularOperationMode, Unselected, Unselected, ArbitraryJobStatus>

Selects -s and enters the plain edit form.

pub fn force( self, ) -> Change<RegularOperationMode, ForceOperationMode, Unselected, Unselected>

Selects -f and enters the plain edit form.

pub fn update( self, ) -> Change<RegularOperationMode, UpdateOperationMode, Unselected, Unselected>

Selects -u and enters the plain edit form.

pub fn original( self, ) -> Change<RegularOperationMode, Unselected, OriginalChangeListMode, Unselected>

Selects -O and enters the plain edit form.

pub fn identity( self, ) -> Change<RegularOperationMode, Unselected, IdentityChangeListMode, Unselected>

Selects -I and enters the plain edit form.

impl<M, P, C, S> Change<M, P, C, S>

pub fn get_bin(&self) -> &Path

Get the Perforce command path.

pub fn set_bin(&mut self, bin: impl Into<PathBuf>) -> &mut Self

Set the Perforce command path.

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

Set the Perforce command path.

pub fn get_global_opts(&self) -> &GlobalOpts

Returns the global options of this command.

pub fn set_global_opts(&mut self, v: GlobalOpts) -> &mut Self

Sets the global options of this command.

pub fn global_opts(self, v: GlobalOpts) -> Self

Builder for the global options of this command.

impl<P, C, S> Change<RegularOperationMode, P, C, S>

pub fn delete(self) -> Change<DeleteMode<LocalDeleteMode>, P, C, S>

where P: TransferDeleteMode, C: TransferDeleteMode,

Transitions to the local delete form (-d), preserving every selected option accepted by that form.

Available when no -u or -I is selected (-d accepts only -f, -s, and -O).

pub fn stdout(self) -> Change<StdoutMode, P, C, S>

where P: TransferStdoutMode,

Transitions to the stdout form (-o), preserving every selected option accepted by that form.

Available when no -u is selected (-o accepts -f, -s, -O, and -I).

impl<P: TransferRemoteDeleteMode> Change<RegularOperationMode, P, Unselected, Unselected>

pub fn server_id( self, server_id: impl Into<String>, ) -> Change<DeleteMode<RemoteDeleteMode>, Unselected, Unselected, Unselected>

Transitions to the remote delete form.

Available from the plain edit form as long as neither -u, -s, -O, nor -I is selected. A previously selected -f is folded into the form’s built-in -f.

server_id is the server id of the commit server the changelist’s client is bound to.

impl<O, S> Change<RegularOperationMode, O, Unselected, S>

pub fn stdin(self) -> Change<StdinMode, O, Unselected, S>

Transitions to the stdin form (-i), preserving every selected option accepted by that form.

Available only when no -O or -I is selected (-i accepts -s, -f, and -u, but no changelist reference).

impl<O, C> Change<RegularOperationMode, O, C, Unselected>

pub fn arbitrary_job_status( self, ) -> Change<RegularOperationMode, O, C, ArbitraryJobStatus>

Selects -s: jobs may be assigned arbitrary status values on submission.

impl<C, S> Change<RegularOperationMode, Unselected, C, S>

pub fn force(self) -> Change<RegularOperationMode, ForceOperationMode, C, S>

Selects -f (force editing of submitted changelists).

Mutually exclusive with -u.

pub fn update(self) -> Change<RegularOperationMode, UpdateOperationMode, C, S>

Selects -u (update a submitted changelist).

Mutually exclusive with -f.

impl<O, S> Change<RegularOperationMode, O, Unselected, S>

pub fn original( self, ) -> Change<RegularOperationMode, O, OriginalChangeListMode, S>

Selects -O: interpret the changelist number as the original, pre-renumber number.

Mutually exclusive with -I.

pub fn identity( self, ) -> Change<RegularOperationMode, O, IdentityChangeListMode, S>

Selects -I: interpret the changelist number as the Identity field.

Mutually exclusive with -O.

impl<O, C> Change<RegularOperationMode, O, C, Unselected>

pub fn visibility( self, visibility: Visibility, ) -> Change<UserOrVisibilityMode, <(O, C) as TransferUVMode>::P, <(O, C) as TransferUVMode>::C, Unselected>

where (O, C): TransferUVMode,

Transitions to the change-type form (-t type), preserving a selected -f, -u, -O, or -I as the form’s single allowed extra option.

Available only when -s is not selected (the -t / -U form does not accept it), and at most one of -f, -u, -O, -I is selected.

visibility selects the new changelist type.

pub fn user( self, user: impl Into<String>, ) -> Change<UserOrVisibilityMode, <(O, C) as TransferUVMode>::P, <(O, C) as TransferUVMode>::C, Unselected>

where (O, C): TransferUVMode,

Transitions to the owner-transfer form (-U user), preserving a selected -f, -u, -O, or -I as the form’s single allowed extra option.

Available only when -s is not selected (the -t / -U form does not accept it), and at most one of -f, -u, -O, -I is selected.

user is the new owner of the empty pending changelist.

Trait Implementations

impl<M: Clone, P: Clone, C: Clone, S: Clone> Clone for Change<M, P, C, S>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<M: Debug, P: Debug, C: Debug, S: Debug> Debug for Change<M, P, C, S>

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

Formats the value using the given formatter.

impl<M: Default, P: Default, C: Default, S: Default> Default for Change<M, P, C, S>

fn default() -> Self

Returns the “default value” for a type.

impl<O, C, S> ParameterizedSpawn<()> for Change<RegularOperationMode, O, C, S>

where O: ExclusiveOption, C: ExclusiveOption, S: ExclusiveOption,

fn spawn_with(&mut self, _: ()) -> Result<Self::Output, Self::Error>

Spawns p4 change (the plain edit form) without a changelist argument, opening the editor to create a new pending changelist.

type Output = Child

type Error = Error

impl<O, C, S> ParameterizedSpawn<()> for Change<StdoutMode, O, C, S>

where O: ExclusiveOption, C: ExclusiveOption, S: ExclusiveOption,

fn spawn_with(&mut self, _: ()) -> Result<Self::Output, Self::Error>

Spawns p4 change -o without a changelist argument, writing the default changelist specification to standard output.

type Output = Child

type Error = Error

impl<O, S> ParameterizedSpawn<()> for Change<StdinMode, O, Unselected, S>

where O: ExclusiveOption, S: ExclusiveOption,

fn spawn_with(&mut self, _: ()) -> Result<Self::Output, Self::Error>

Spawns p4 change -i with a piped standard input stream (and piped standard output and error streams); write the changelist specification to the returned Child’s stdin handle.

type Output = Child

type Error = Error

impl<M, O, C, S, I> ParameterizedSpawn<(I,)> for Change<M, O, C, S>

where M: ExclusiveOption + TakesChangeList, O: ExclusiveOption, C: ExclusiveOption, S: ExclusiveOption, I: AsRef<OsStr>,

fn spawn_with( &mut self, (changelist): (I,), ) -> Result<Self::Output, Self::Error>

Spawns p4 change with the given changelist argument as a child process with piped standard output and error streams; use the returned Child handle to wait for it or interact with it.

The changelist argument is a changelist number, optionally prefixed by the form’s reference option semantics (for example an original pre-renumber number under -O).

type Output = Child

type Error = Error

impl<O, S> ParameterizedSpawn<(Stdio,)> for Change<StdinMode, O, Unselected, S>

where O: ExclusiveOption, S: ExclusiveOption,

fn spawn_with(&mut self, (stdio): (Stdio,)) -> Result<Self::Output, Self::Error>

Spawns p4 change -i with the given standard input configuration and piped standard output and error streams; use the returned Child handle to wait for it or interact with it.

Pass Stdio::piped() to obtain a writable child.stdin handle and feed the changelist specification into it; pass Stdio::inherit() to read the specification from the spawning process’s own standard input.

type Output = Child

type Error = Error

impl<M, O, C, S> SubCommand for Change<M, O, C, S>

where M: ExclusiveOption, O: ExclusiveOption, C: ExclusiveOption, S: ExclusiveOption,

fn name(&self) -> &str

fn inject_local_args(&self, command: &mut Command)

fn global_opts(&self) -> Option<&GlobalOpts>

fn inject_args(&self, command: &mut Command)

fn setup_command<S: AsRef<OsStr>>(&self, bin: S) -> Command