Struct BackGroundTask 

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

Type-safe builder for p4 bgtask.

Run background commands or triggers on the server. The server saves the task output to its log file; this command requires super access.

Syntax

p4 [g-opts] bgtask [-b retries] [-d] [-i interval] [-m runCount]
                   [-w seconds] {-e command | -t triggerName}

The M type parameter tracks the required task target at compile time: it starts as Unselected, and one of Self::execute / Self::trigger must be used to move into the CommandMode / TriggerMode state before the command can be spawned. The two states can be switched freely with the same two methods.

Implementations

impl BackGroundTask<Unselected>

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

Creates a new p4 bgtask command with no task target selected.

bin is the path to the Perforce command-line executable. Use Self::execute or Self::trigger to select the required -e / -t target.

impl<M> BackGroundTask<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 execute(self, command: impl Into<String>) -> BackGroundTask<CommandMode>

Selects -e command: run the given command string on the server.

This transitions into the CommandMode state, discarding any previously selected -e / -t target; the scheduling options are preserved.

pub fn trigger(self, name: impl Into<String>) -> BackGroundTask<TriggerMode>

Selects -t triggerName: run the named bgtask trigger, already defined in the triggers table, on the server.

This transitions into the TriggerMode state, discarding any previously selected -e / -t target; the scheduling options are preserved.

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.

pub fn get_retries(&self) -> Option<u64>

Description

-b retries

Maximum number of execution errors before ceasing to attempt execution. The default is 1.

pub fn set_retries(&mut self, v: u64) -> &mut Self

Description

-b retries

Maximum number of execution errors before ceasing to attempt execution. The default is 1.

pub fn retries(self, v: u64) -> Self

Description

-b retries

Maximum number of execution errors before ceasing to attempt execution. The default is 1.

pub fn get_detach(&self) -> bool

Description

-d

Detach the client so it does not see the output of the server-side task execution. Not allowed when the task is specified in a startup.N configurable.

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

Description

-d

Detach the client so it does not see the output of the server-side task execution. Not allowed when the task is specified in a startup.N configurable.

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

Description

-d

Detach the client so it does not see the output of the server-side task execution. Not allowed when the task is specified in a startup.N configurable.

pub fn get_interval(&self) -> Option<u64>

Description

-i interval

Seconds between command invocations. The default is 1 second; the maximum is 2,678,400 (the number of seconds in 31 days).

pub fn set_interval(&mut self, v: u64) -> &mut Self

Description

-i interval

Seconds between command invocations. The default is 1 second; the maximum is 2,678,400 (the number of seconds in 31 days).

pub fn interval(self, v: u64) -> Self

Description

-i interval

Seconds between command invocations. The default is 1 second; the maximum is 2,678,400 (the number of seconds in 31 days).

pub fn get_runs(&self) -> Option<u64>

Description

-m runCount

Maximum number of times the command is run. The default is 1.

pub fn set_runs(&mut self, v: u64) -> &mut Self

Description

-m runCount

Maximum number of times the command is run. The default is 1.

pub fn runs(self, v: u64) -> Self

Description

-m runCount

Maximum number of times the command is run. The default is 1.

pub fn get_wait(&self) -> Option<u64>

Description

-w seconds

Seconds to wait after an execution error before attempting the next execution. The default is 5.

pub fn set_wait(&mut self, v: u64) -> &mut Self

Description

-w seconds

Seconds to wait after an execution error before attempting the next execution. The default is 5.

pub fn wait(self, v: u64) -> Self

Description

-w seconds

Seconds to wait after an execution error before attempting the next execution. The default is 5.

impl BackGroundTask<CommandMode>

pub fn get_command(&self) -> &str

The command string selected with -e.

impl BackGroundTask<TriggerMode>

pub fn get_trigger(&self) -> &str

The trigger name selected with -t.

Trait Implementations

impl<M: Clone> Clone for BackGroundTask<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 BackGroundTask<M>

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

Formats the value using the given formatter.

impl<M: Default> Default for BackGroundTask<M>

fn default() -> Self

Returns the “default value” for a type.

impl<M: TaskTarget> ParameterizedSpawn<()> for BackGroundTask<M>

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

Spawns p4 bgtask 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<M: ExclusiveOption> SubCommand for BackGroundTask<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