Skip to main content

Clean

Struct Clean 

Source
pub struct Clean { /* private fields */ }
Expand description

p4 [g-opts] clean [-e -a -d -I -l -K -m -n] [file ...]

Restore client workspace files to match the state of corresponding depot files. This command is equivalent to p4 reconcile -w: files present in the workspace but missing from the depot are deleted; files present in the depot but missing from the workspace are added at the revision synced from the depot; and files modified in the workspace that are not opened for add, edit, delete, or integrate are restored to the last revision synced from the depot.

Without file arguments, the files in your local working directory are used.

Implementations§

Source§

impl Clean

Source

pub fn get_bin(&self) -> &Path

Get the Perforce command path.

Source

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

Set the Perforce command path.

Source

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

Set the Perforce command path.

Source

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

Create a new p4 clean command.

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

Source

pub fn get_global_opts(&self) -> &GlobalOpts

§Description

g-opts

See Global options.

Source

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

§Description

g-opts

See Global options.

Source

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

§Description

g-opts

See Global options.

Source

pub fn get_find_edited(&self) -> bool

§Description

-e

Edited files: Find files in the workspace that have been modified and restore them to the last file version that has synced from the depot.

Source

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

§Description

-e

Edited files: Find files in the workspace that have been modified and restore them to the last file version that has synced from the depot.

Source

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

§Description

-e

Edited files: Find files in the workspace that have been modified and restore them to the last file version that has synced from the depot.

Source

pub fn get_find_added(&self) -> bool

§Description

-a

Added files: Find files in the workspace that have no corresponding files in the depot and delete them.

Source

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

§Description

-a

Added files: Find files in the workspace that have no corresponding files in the depot and delete them.

Source

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

§Description

-a

Added files: Find files in the workspace that have no corresponding files in the depot and delete them.

Source

pub fn get_find_deleted(&self) -> bool

§Description

-d

Deleted files: Find those files in the depot that do not exist in your workspace and add them to the workspace.

Source

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

§Description

-d

Deleted files: Find those files in the depot that do not exist in your workspace and add them to the workspace.

Source

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

§Description

-d

Deleted files: Find those files in the depot that do not exist in your workspace and add them to the workspace.

Source

pub fn get_ignore_p4ignore(&self) -> bool

§Description

-I

Do not perform any ignore checking, which means to ignore any settings specified by P4IGNORE for added files.

Source

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

§Description

-I

Do not perform any ignore checking, which means to ignore any settings specified by P4IGNORE for added files.

Source

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

§Description

-I

Do not perform any ignore checking, which means to ignore any settings specified by P4IGNORE for added files.

Source

pub fn get_local_file_syntax(&self) -> bool

§Description

-l

Display output in local file syntax with relative paths, similar to the workspace-centric view of p4 status.

Source

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

§Description

-l

Display output in local file syntax with relative paths, similar to the workspace-centric view of p4 status.

Source

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

§Description

-l

Display output in local file syntax with relative paths, similar to the workspace-centric view of p4 status.

Source

pub fn get_suppress_keyword_expansion(&self) -> bool

§Description

-K

Suppress keyword expansion when updating +k type files on the client. See File type modifiers.

Source

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

§Description

-K

Suppress keyword expansion when updating +k type files on the client. See File type modifiers.

Source

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

§Description

-K

Suppress keyword expansion when updating +k type files on the client. See File type modifiers.

Source

pub fn get_fast_timestamp_check(&self) -> bool

§Description

-m

Compare the file sync or submit time (in the depot) with the file modification time (in the workspace) to help determine whether the file has changed. Normally P4 Server uses file digests to determine whether files in the workspace differ from the head revisions of these files in the depot. This can be time consuming for large files. But when the timestamps are the same, the costly digest comparisons can be skipped. This option is only relevant if you are using clean to find changed files rather than files that were deleted or added.

Source

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

§Description

-m

Compare the file sync or submit time (in the depot) with the file modification time (in the workspace) to help determine whether the file has changed. Normally P4 Server uses file digests to determine whether files in the workspace differ from the head revisions of these files in the depot. This can be time consuming for large files. But when the timestamps are the same, the costly digest comparisons can be skipped. This option is only relevant if you are using clean to find changed files rather than files that were deleted or added.

Source

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

§Description

-m

Compare the file sync or submit time (in the depot) with the file modification time (in the workspace) to help determine whether the file has changed. Normally P4 Server uses file digests to determine whether files in the workspace differ from the head revisions of these files in the depot. This can be time consuming for large files. But when the timestamps are the same, the costly digest comparisons can be skipped. This option is only relevant if you are using clean to find changed files rather than files that were deleted or added.

Source

pub fn get_preview(&self) -> bool

§Description

-n

Preview the results of the operation without performing any action.

Source

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

§Description

-n

Preview the results of the operation without performing any action.

Source

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

§Description

-n

Preview the results of the operation without performing any action.

Trait Implementations§

Source§

impl Clone for Clean

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Clean

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Clean

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl ParameterizedSpawn<()> for Clean

Source§

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

Spawns p4 clean without file arguments as a child process, so the files in your local working directory are reconciled.

The child process has its standard output and error streams piped; use the returned Child handle to wait for it or interact with it.

Source§

type Output = Child

Source§

type Error = Error

Source§

impl<S, I> ParameterizedSpawn<(S,)> for Clean
where S: IntoIterator<Item = I>, I: AsRef<OsStr>,

Source§

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

Spawns p4 clean for the given files as a child process.

The child process has its standard output and error streams piped; use the returned Child handle to wait for it or interact with it.

Source§

type Output = Child

Source§

type Error = Error

Source§

impl SubCommand for Clean

Source§

fn name(&self) -> &str

Source§

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

Source§

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

Source§

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

Source§

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

Auto Trait Implementations§

§

impl Freeze for Clean

§

impl RefUnwindSafe for Clean

§

impl Send for Clean

§

impl Sync for Clean

§

impl Unpin for Clean

§

impl UnsafeUnpin for Clean

§

impl UnwindSafe for Clean

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> OutputExt for T
where T: SpawnExt<Output = Child, Error = Error>,

Source§

impl<T, T1> OutputExt1<T1> for T
where T: SpawnExt1<T1, Output = Child, Error = Error>,

Source§

fn output( &mut self, a: T1, ) -> Result<Output, <T as ParameterizedSpawn<(T1,)>>::Error>

Source§

impl<T, I> ParameterizedOutput<I> for T
where T: ParameterizedSpawn<I, Output = Child, Error = Error>,

Source§

type Error = Error

Source§

fn output_with( &mut self, input: I, ) -> Result<Output, <T as ParameterizedOutput<I>>::Error>

Source§

impl<T> SpawnExt for T

Source§

fn spawn( &mut self, ) -> Result<<T as ParameterizedSpawn<()>>::Output, <T as ParameterizedSpawn<()>>::Error>

Source§

impl<T, T1> SpawnExt1<T1> for T

Source§

fn spawn( &mut self, a: T1, ) -> Result<<T as ParameterizedSpawn<(T1,)>>::Output, <T as ParameterizedSpawn<(T1,)>>::Error>

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.