Struct P4Cli 

pub struct P4Cli { /* private fields */ }

Implementations

impl P4Cli

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

Create a new Perforce command-line client.

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

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

Set the Perforce command path.

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

Set the global options.

pub fn get_bin(&self) -> &Path

Get the Perforce command path.

pub fn get_global_opts(&self) -> &GlobalOpts

Get the global options.

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

Set the Perforce command path.

pub fn set_global_opts(&mut self, global_opts: GlobalOpts)

Set the global options.

pub fn add(&self) -> Add

Open files in a client workspace for addition to the depot.

pub fn admin(&self) -> AdminEntry

Perform administrative operations on the server.

pub fn aliases(&self) -> Aliases

Display command aliases that are currently defined in a .p4aliases file.

pub fn annotate(&self) -> Annotate

Print file lines along with their revisions.

pub fn archive(&self) -> Archive

Archive obsolete revisions to an archive depot.

pub fn attribute(&self) -> Attribute

Set per-revision attributes on file revisions.

pub fn bgtask(&self) -> BackGroundTask

Run a background command or trigger on the server.

The returned builder starts with no task target; call BackGroundTask::execute (-e) or BackGroundTask::trigger (-t) to select the required target before spawning.

pub fn branch(&self) -> Branch

Create or edit a branch mapping and its view.

pub fn branches(&self) -> Branches

List existing branch mappings.

pub fn cachepurge(&self) -> CachePurge

Reclaim disk space on a replicated server.

The returned builder starts with no purge goal and has no effect; call CachePurge::purge_all (-a), CachePurge::free_space (-f), CachePurge::revision_count (-m), or CachePurge::size (-s) to select the required goal before spawning.

pub fn clean(&self) -> Clean

Restore client workspace files to match the state of corresponding depot files.

Without file arguments, the files in your local working directory are used; pass file arguments to ParameterizedSpawn::spawn_with to limit the scope.

pub fn client(&self) -> Client

Create or edit a client workspace specification and its view.

The returned builder starts in the GeneralMode state (p4 client [-f] [-t template] [-T type] [name]); call transition methods such as Client::delete or Client::stdout to select another syntax form.

pub fn workspace(&self) -> Client

Create or edit a client workspace specification and its view.

This is an alias for Self::client, corresponding to the p4 workspace command.

pub fn change(&self) -> Change

Create or edit a changelist specification.

pub fn changelist(&self) -> Change

Create or edit a changelist specification.

This is an alias for Self::change, corresponding to the p4 changelist command.

pub fn changes(&self) -> Changes

List submitted and pending changelists.

pub fn changelists(&self) -> Changes

List submitted and pending changelists.

This is an alias for Self::changes, corresponding to the p4 changelists command.

pub fn describe(&self) -> Describe

Display the details of one or more changelists.

pub fn diff(&self) -> Diff

Diff workspace content against depot content, or diff stream specs.

Examples found in repository

examples/diff.rs (line 46)

fn main() -> std::io::Result<()> {
    let p4 = P4Cli::default();

    // Workspace mode: force a diff against head, use the unified format with
    // whitespace-insensitive comparison, and limit output to the first 10
    // files. `force(true)` transitions the command into `WorkspaceMode`, and
    // `limit(10)` further transitions it into `WorkspaceRegularMode` (where
    // `-soptions` is unavailable).
    let mut diff = p4
        .diff()
        .force(true)
        .diff_options(DiffOptionsBuilder::unified(None).ignore_all_whitespace())
        .limit(10);

    let files = [OsStr::new("//depot/project/src/...")];
    let output = diff.output_with((&files,))?;
    println!("{}", String::from_utf8_lossy(&output.stdout));

    // Display mode: instead of full diffs, list only the unopened files that
    // differ from the depot. `display_options` transitions `WorkspaceMode`
    // into `WorkspaceDisplayMode`, where `-m max` is unavailable.
    let mut list_changed = p4
        .diff()
        .force(true)
        .display_options(DisplayOptions::UnopenedChanged);

    let output = list_changed.output(files)?;
    println!("{}", String::from_utf8_lossy(&output.stdout));

    // Stream-spec mode: diff a privately edited stream spec against the head
    // version of another stream. `stream_spec_mode` transitions the command
    // into `StreamSpecMode`; the stream spec is passed to `spawn_with`.
    #[cfg(not(feature = "lt2019_1"))]
    {
        let mut stream_diff = p4.diff().stream_spec_mode();
        let mut child = stream_diff.spawn_with(("//streams/main@head",))?;
        child.wait()?;
    }

    Ok(())
}

pub fn diff2(&self) -> Diff2

Compare the content at two depot paths, or compare two stream specs.

pub fn edit(&self) -> Edit

Open files in a client workspace for edit.

pub fn filelog(&self) -> FileLog

Print detailed information about the revisions of files.

Examples found in repository

examples/filelog.rs (line 31)

fn main() -> std::io::Result<()> {
    let p4 = P4Cli::default();

    // Revision history for every file under //depot/project: follow the file
    // history across branches (`-i`), display the time as well as the date
    // (`-t`), and list only the first 10 changes per file (`-m 10`).
    let mut filelog = p4
        .filelog()
        .follow_branches(true)
        .include_time(true)
        .limit(10);

    let files = [OsStr::new("//depot/project/...")];
    let output = filelog.output(&files)?;
    println!("{}", String::from_utf8_lossy(&output.stdout));

    // Long output: `full_description()` transitions the command into the
    // `FullDescription` state (`-l`), printing the full text of each
    // changelist description. A revision range limits the listed revisions,
    // e.g. changelists 100 through 120.
    let mut long_log = p4.filelog().full_description();

    let output = long_log.output(&["//depot/project/main.c@100,@120"])?;
    println!("{}", String::from_utf8_lossy(&output.stdout));

    // Content history: `content_history()` transitions the command into the
    // `DisplayContentHistory` state (`-h`), which unlocks `-p` to skip the
    // content of promoted task streams. Only revisions submitted at
    // changelist 4321 are displayed (`-c 4321`).
    let mut history = p4
        .filelog()
        .content_history()
        .skip_promoted_tasks(true)
        .changelist("4321");

    let mut child = history.spawn_with((&files,))?;
    child.wait()?;

    Ok(())
}

pub fn print(&self) -> Print

Print the contents of depot file revisions.

Examples found in repository

examples/print.rs (line 21)

fn main() -> std::io::Result<()> {
    let p4 = P4Cli::default();

    // Chain builders: print all revisions of the first two matching files to
    // a local output file, without the depot header line.
    let mut print = p4
        .print()
        .all_revisions(true)
        .quiet_mode(true)
        .limit(2)
        .redirect_output("print-output.txt");

    // Run the command to completion and capture its output.
    let file = Path::new("//depot/project/README.md");
    let output = print.output_with((&[file.as_os_str()],))?;
    println!("{}", String::from_utf8_lossy(&output.stdout));

    // Or stream the contents directly to the terminal with `spawn_with`.
    let mut child = p4
        .print()
        .spawn_with((&[OsStr::new("//depot/project/README.md")],))?;
    child.wait()?;

    Ok(())
}

pub fn sync(&self) -> Sync

Update the client workspace to reflect the contents of the depot.

pub fn where(&self) -> Where

Show where a particular file is located, as determined by the client view.

Trait Implementations

impl Clone for P4Cli

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for P4Cli

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

Formats the value using the given formatter.

impl Default for P4Cli

fn default() -> Self

Returns the “default value” for a type.