Struct Branch 

pub struct Branch<M = Unselected> { /* private fields */ }

Type-safe builder for p4 branch.

Create or edit a branch mapping and its view.

Syntax

p4 [g-opts] branch [-f] branchspec
p4 [g-opts] branch -d [-f] branchspec
p4 [g-opts] branch -i [-f]
p4 [g-opts] branch [-S stream] -o placeholderForStreamBranchSpecName
p4 [g-opts] branch [-S stream -P parent] -o placeholderForStreamBranchSpecName

The M type parameter tracks the command form at compile time, starting as Unselected from Branch::new. Enter a form with one of Self::force, Self::delete, Self::stdin, or Self::stdout:

• GeneralMode (entered via Self::force): create or edit a branch mapping; can transition to DeleteMode or StdinMode preserving the -f flag.
• DeleteMode (-d, entered via Self::delete): delete a branch mapping.
• StdinMode (-i, entered via Self::stdin): read the branch mapping from standard input.
• StdoutMode (-o, entered via Self::stdout): write the branch mapping to standard output; the -S stream and -P parent options are available as fields on this form.

Implementations

impl Branch<Unselected>

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

Creates a new p4 branch command with no form selected.

bin is the path to the Perforce command-line executable. Use Self::force, Self::delete, Self::stdin, or Self::stdout to select a form before spawning.

pub fn force(self, v: bool) -> Branch<GeneralMode>

Enters the general form: p4 branch [-f] branchspec.

v sets the initial state of the -f flag.

pub fn delete(self) -> Branch<DeleteMode>

Enters the delete form: p4 branch -d [-f] branchspec.

pub fn stdin(self) -> Branch<StdinMode>

Enters the stdin form: p4 branch -i [-f].

pub fn stdout(self) -> Branch<StdoutMode>

Enters the stdout form: p4 branch [-S stream [-P parent]] -o placeholder.

Use Branch::stream and Branch::parent on the entered form to add the -S and -P options.

impl<M> Branch<M>

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

Description

g-opts

See Global options.

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

Description

g-opts

See Global options.

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

Description

g-opts

See Global options.

impl Branch<GeneralMode>

pub fn get_force(&self) -> bool

Description

-f

Force option. Combined with -d, permits P4 Server administrators to delete branches they don’t own. Also permits administrators to change the modification date of the branch mapping (the Update field is writable when using the -f option).

pub fn set_force(&mut self, v: bool) -> &mut Self

Description

-f

Force option. Combined with -d, permits P4 Server administrators to delete branches they don’t own. Also permits administrators to change the modification date of the branch mapping (the Update field is writable when using the -f option).

pub fn force(self, v: bool) -> Self

Description

-f

Force option. Combined with -d, permits P4 Server administrators to delete branches they don’t own. Also permits administrators to change the modification date of the branch mapping (the Update field is writable when using the -f option).

pub fn delete(self) -> Branch<DeleteMode>

Transitions to the delete form (-d), preserving the -f flag.

pub fn stdin(self) -> Branch<StdinMode>

Transitions to the stdin form (-i), preserving the -f flag.

impl Branch<DeleteMode>

pub fn get_force(&self) -> bool

Description

-f

Force option. Permits P4 Server administrators to delete branches they don’t own.

pub fn set_force(&mut self, v: bool) -> &mut Self

Description

-f

Force option. Permits P4 Server administrators to delete branches they don’t own.

pub fn force(self, v: bool) -> Self

Description

-f

Force option. Permits P4 Server administrators to delete branches they don’t own.

impl Branch<StdinMode>

pub fn get_force(&self) -> bool

Description

-f

Force option. Permits administrators to change the modification date of the branch mapping.

pub fn set_force(&mut self, v: bool) -> &mut Self

Description

-f

Force option. Permits administrators to change the modification date of the branch mapping.

pub fn force(self, v: bool) -> Self

Description

-f

Force option. Permits administrators to change the modification date of the branch mapping.

impl Branch<StdoutMode>

pub fn get_stream(&self) -> Option<&String>

Description

-S stream

Display the mapping generated for the specified stream. This option enables you to see how change is propagated between the stream and its parent.

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

Description

-S stream

Display the mapping generated for the specified stream. This option enables you to see how change is propagated between the stream and its parent.

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

Description

-S stream

Display the mapping generated for the specified stream. This option enables you to see how change is propagated between the stream and its parent.

pub fn get_parent(&self) -> Option<&String>

Description

-P parent

For a specified stream, display the mapping that is generated by hypothetically treating the stream as if it were a child of the specified parent. Requires -S.

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

Description

-P parent

For a specified stream, display the mapping that is generated by hypothetically treating the stream as if it were a child of the specified parent. Requires -S.

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

Description

-P parent

For a specified stream, display the mapping that is generated by hypothetically treating the stream as if it were a child of the specified parent. Requires -S.

Trait Implementations

impl<M: Clone> Clone for Branch<M>

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> Debug for Branch<M>

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

Formats the value using the given formatter.

impl<M: Default> Default for Branch<M>

fn default() -> Self

Returns the “default value” for a type.

impl ParameterizedSpawn<()> for Branch<GeneralMode>

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

Spawns p4 branch (the general form) without a branchspec argument, opening the editor to create a new branch mapping.

type Output = Child

type Error = Error

impl ParameterizedSpawn<()> for Branch<StdinMode>

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

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

type Output = Child

type Error = Error

impl<I: AsRef<OsStr>> ParameterizedSpawn<(I,)> for Branch<GeneralMode>

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

Spawns p4 branch with the given branchspec 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.

type Output = Child

type Error = Error

impl<I: AsRef<OsStr>> ParameterizedSpawn<(I,)> for Branch<DeleteMode>

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

Spawns p4 branch -d with the given branchspec 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.

type Output = Child

type Error = Error

impl<I: AsRef<OsStr>> ParameterizedSpawn<(I,)> for Branch<StdoutMode>

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

Spawns p4 branch [-S stream [-P parent]] -o with the given placeholder 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.

type Output = Child

type Error = Error

impl ParameterizedSpawn<(Stdio,)> for Branch<StdinMode>

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

Spawns p4 branch -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 branch mapping 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: ExclusiveOption> SubCommand for Branch<M>

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