Struct Print 

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

p4 print [-a -A -K -o localFile -q -m max --offset offset --size size -Q charset -B utf8bom -L line-ending] [--ignore-changeview] file[revRange] ...

p4 print -U unloadfile ...

p4 print -T attribute [-a -q -o localFile] [--ignore-changeview] file ...

Print the contents of a depot file revision.

The M type parameter tracks which of the three forms of the command is in use at compile time. The default Unselected state prints files without local options; setting any standard option such as Self::all_revisions transitions to StandardPrintMode, Self::from_unload_depot transitions to UnloadDepotMode, and Self::extract_attribute transitions to AttributeTraitMode.

Implementations

impl Print<Unselected>

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

Creates a new p4 print command.

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

pub fn from_unload_depot(self) -> Print<UnloadDepotMode>

Description

-U

Look for the specified file or files in the unload depot. Data about an unloaded client, label, or task stream can be printed.

Transitions this command to the UnloadDepotMode state; no other local option can be combined with -U.

pub fn extract_attribute( self, name: impl Into<String>, ) -> Print<AttributeTraitMode>

Description

-T attribute

Print the value of the specified non-encoded attribute of the specified file. This command, rather than p4 fstat -Oa, is appropriate for non-encoded binary attributes larger than 250 megabytes. The p4 fstat -Oa command might fail with the Rpc buffer too big to send error if attributes exceed 250 megabytes. The p4 print command has no option to show the value of the attribute in hex. For that, use the p4 fstat -Oe command.

Transitions this command to the AttributeTraitMode state.

pub fn all_revisions(self, v: bool) -> Print<StandardPrintMode>

Description

-a

For each file, print all revisions within a specified revision range, rather than only the highest revision in the range.

Transitions this command to the StandardPrintMode state.

Examples found in repository

examples/print.rs (line 22)

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 archive_depots(self, v: bool) -> Print<StandardPrintMode>

Description

-A

Print files in archive depots.

Transitions this command to the StandardPrintMode state.

pub fn suppress_keyword_expansion(self, v: bool) -> Print<StandardPrintMode>

Description

-K

Suppress RCS keyword expansion. This replaced the -k flag in 2022.1, which is now an alias for -K for backwards compatibility.

Transitions this command to the StandardPrintMode state.

pub fn redirect_output(self, v: impl Into<PathBuf>) -> Print<StandardPrintMode>

Description

-o localfile

Redirect output to the specified output file (localfile) on the local disk. This preserves the same file type, attributes, and/or permission bits as the original file (FileSpec) in the depot. Multiple files can be written by using wildcards in the localFile argument that match wildcards in the depot (FileSpec) argument. For example: To print the contents of a directory and directories under that directory, use the ... wildcard: p4 print -o c:/tmp/main-copy/... //depot/main/... To print all files that match readme.txt or readme.pdf, you might specify p4 print -o readme.* //depot/readme.*

Transitions this command to the StandardPrintMode state.

pub fn quiet_mode(self, v: bool) -> Print<StandardPrintMode>

Description

-q

Suppress the one-line file header normally added by P4 Server.

Transitions this command to the StandardPrintMode state.

pub fn limit(self, v: u64) -> Print<StandardPrintMode>

Description

-m max

Print only the first max files.

Transitions this command to the StandardPrintMode state.

pub fn offset(self, v: u64) -> Print<StandardPrintMode>

Description

–offset bytesToSkip

(Optional) Skip the specified number of bytes and only print what follows. Can be used with --size.

Transitions this command to the StandardPrintMode state.

pub fn size(self, v: u64) -> Print<StandardPrintMode>

Description

–size bytesToPrint

(Optional) Print the specified number of bytes from the offset. If --offset is not explicitly set, prints the specified number of bytes from the beginning of the file.

Transitions this command to the StandardPrintMode state.

pub fn charset(self, v: impl Into<String>) -> Print<StandardPrintMode>

Description

-Q charset

Allow the charset for unicode type files to be explicitly specified, overriding the connection’s P4CHARSET but not overriding the charset of unicode files with versioned charsets.

Transitions this command to the StandardPrintMode state.

pub fn write_utf8bom(self, v: bool) -> Print<StandardPrintMode>

Description

-B 1 / -B 0

Override the client-side filesys.utf8bom setting, controlling the presence of the byte-order-mark in utf8 type files. With true, write utf8 files with a BOM (-B 1); with false, do not write a BOM (-B 0).

Transitions this command to the StandardPrintMode state.

pub fn write_utf8bom_windows_only(self) -> Print<StandardPrintMode>

Description

-B 2

Override the client-side filesys.utf8bom setting to write the BOM only on Windows.

Transitions this command to the StandardPrintMode state.

pub fn line_ending_unix(self) -> Print<StandardPrintMode>

Description

-L unix

Allow the line ending of textual files to be explicitly specified as ‘unix’, ‘win’, or ‘mac’.

Transitions this command to the StandardPrintMode state.

pub fn line_ending_win(self) -> Print<StandardPrintMode>

Description

-L win

Allow the line ending of textual files to be explicitly specified as ‘unix’, ‘win’, or ‘mac’.

Transitions this command to the StandardPrintMode state.

pub fn line_ending_mac(self) -> Print<StandardPrintMode>

Description

-L mac

Allow the line ending of textual files to be explicitly specified as ‘unix’, ‘win’, or ‘mac’.

Transitions this command to the StandardPrintMode state.

pub fn ignore_changeview(self, v: bool) -> Print<StandardPrintMode>

Description

–ignore-changeview

Remove the changelist limit on depot paths. See ChangeView in p4 client.

Transitions this command to the StandardPrintMode state.

impl<M: ExclusiveOption> Print<M>

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 Print<StandardPrintMode>

pub fn get_all_revisions(&self) -> bool

Description

-a

For each file, print all revisions within a specified revision range, rather than only the highest revision in the range.

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

Description

-a

For each file, print all revisions within a specified revision range, rather than only the highest revision in the range.

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

Description

-a

For each file, print all revisions within a specified revision range, rather than only the highest revision in the range.

pub fn get_archive_depots(&self) -> bool

Description

-A

Print files in archive depots.

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

Description

-A

Print files in archive depots.

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

Description

-A

Print files in archive depots.

pub fn get_suppress_keyword_expansion(&self) -> bool

Description

-K

Suppress RCS keyword expansion. This replaced the -k flag in 2022.1, which is now an alias for -K for backwards compatibility.

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

Description

-K

Suppress RCS keyword expansion. This replaced the -k flag in 2022.1, which is now an alias for -K for backwards compatibility.

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

Description

-K

Suppress RCS keyword expansion. This replaced the -k flag in 2022.1, which is now an alias for -K for backwards compatibility.

pub fn get_redirect_output(&self) -> Option<&PathBuf>

Description

-o localfile

Redirect output to the specified output file (localfile) on the local disk. This preserves the same file type, attributes, and/or permission bits as the original file (FileSpec) in the depot. Multiple files can be written by using wildcards in the localFile argument that match wildcards in the depot (FileSpec) argument. For example: To print the contents of a directory and directories under that directory, use the ... wildcard: p4 print -o c:/tmp/main-copy/... //depot/main/... To print all files that match readme.txt or readme.pdf, you might specify p4 print -o readme.* //depot/readme.*

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

Description

-o localfile

Redirect output to the specified output file (localfile) on the local disk. This preserves the same file type, attributes, and/or permission bits as the original file (FileSpec) in the depot. Multiple files can be written by using wildcards in the localFile argument that match wildcards in the depot (FileSpec) argument. For example: To print the contents of a directory and directories under that directory, use the ... wildcard: p4 print -o c:/tmp/main-copy/... //depot/main/... To print all files that match readme.txt or readme.pdf, you might specify p4 print -o readme.* //depot/readme.*

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

Description

-o localfile

Redirect output to the specified output file (localfile) on the local disk. This preserves the same file type, attributes, and/or permission bits as the original file (FileSpec) in the depot. Multiple files can be written by using wildcards in the localFile argument that match wildcards in the depot (FileSpec) argument. For example: To print the contents of a directory and directories under that directory, use the ... wildcard: p4 print -o c:/tmp/main-copy/... //depot/main/... To print all files that match readme.txt or readme.pdf, you might specify p4 print -o readme.* //depot/readme.*

Examples found in repository

examples/print.rs (line 25)

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 get_quiet_mode(&self) -> bool

Description

-q

Suppress the one-line file header normally added by P4 Server.

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

Description

-q

Suppress the one-line file header normally added by P4 Server.

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

Description

-q

Suppress the one-line file header normally added by P4 Server.

Examples found in repository

examples/print.rs (line 23)

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 get_limit(&self) -> Option<u64>

Description

-m max

Print only the first max files.

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

Description

-m max

Print only the first max files.

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

Description

-m max

Print only the first max files.

Examples found in repository

examples/print.rs (line 24)

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 get_offset(&self) -> Option<u64>

Description

–offset bytesToSkip

(Optional) Skip the specified number of bytes and only print what follows. Can be used with --size.

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

Description

–offset bytesToSkip

(Optional) Skip the specified number of bytes and only print what follows. Can be used with --size.

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

Description

–offset bytesToSkip

(Optional) Skip the specified number of bytes and only print what follows. Can be used with --size.

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

Description

–size bytesToPrint

(Optional) Print the specified number of bytes from the offset. If --offset is not explicitly set, prints the specified number of bytes from the beginning of the file.

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

Description

–size bytesToPrint

(Optional) Print the specified number of bytes from the offset. If --offset is not explicitly set, prints the specified number of bytes from the beginning of the file.

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

Description

–size bytesToPrint

(Optional) Print the specified number of bytes from the offset. If --offset is not explicitly set, prints the specified number of bytes from the beginning of the file.

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

Description

-Q charset

Allow the charset for unicode type files to be explicitly specified, overriding the connection’s P4CHARSET but not overriding the charset of unicode files with versioned charsets.

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

Description

-Q charset

Allow the charset for unicode type files to be explicitly specified, overriding the connection’s P4CHARSET but not overriding the charset of unicode files with versioned charsets.

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

Description

-Q charset

Allow the charset for unicode type files to be explicitly specified, overriding the connection’s P4CHARSET but not overriding the charset of unicode files with versioned charsets.

pub fn get_utf8bom(&self) -> Option<Utf8Bom>

Description

-B utf8bom

Override the client-side filesys.utf8bom setting, controlling the presence of the byte-order-mark in utf8 type files.

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

Description

-B 1 / -B 0

Override the client-side filesys.utf8bom setting, controlling the presence of the byte-order-mark in utf8 type files. With true, write utf8 files with a BOM (-B 1); with false, do not write a BOM (-B 0).

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

Description

-B 1 / -B 0

Override the client-side filesys.utf8bom setting, controlling the presence of the byte-order-mark in utf8 type files. With true, write utf8 files with a BOM (-B 1); with false, do not write a BOM (-B 0).

pub fn set_write_utf8bom_windows_only(&mut self) -> &mut Self

Description

-B 2

Override the client-side filesys.utf8bom setting to write the BOM only on Windows.

pub fn write_utf8bom_windows_only(self) -> Self

Description

-B 2

Override the client-side filesys.utf8bom setting to write the BOM only on Windows.

pub fn get_line_ending(&self) -> Option<LineEnding>

Description

-L line-ending

Allow the line ending of textual files to be explicitly specified as ‘unix’, ‘win’, or ‘mac’.

Returns the line ending currently set, or None if no line ending is set.

pub fn set_line_ending_unix(&mut self) -> &mut Self

Description

-L unix

Allow the line ending of textual files to be explicitly specified as ‘unix’, ‘win’, or ‘mac’.

pub fn line_ending_unix(self) -> Self

Description

-L unix

Allow the line ending of textual files to be explicitly specified as ‘unix’, ‘win’, or ‘mac’.

pub fn set_line_ending_win(&mut self) -> &mut Self

Description

-L win

Allow the line ending of textual files to be explicitly specified as ‘unix’, ‘win’, or ‘mac’.

pub fn line_ending_win(self) -> Self

Description

-L win

Allow the line ending of textual files to be explicitly specified as ‘unix’, ‘win’, or ‘mac’.

pub fn set_line_ending_mac(&mut self) -> &mut Self

Description

-L mac

Allow the line ending of textual files to be explicitly specified as ‘unix’, ‘win’, or ‘mac’.

pub fn line_ending_mac(self) -> Self

Description

-L mac

Allow the line ending of textual files to be explicitly specified as ‘unix’, ‘win’, or ‘mac’.

pub fn get_ignore_changeview(&self) -> bool

Description

–ignore-changeview

Remove the changelist limit on depot paths. See ChangeView in p4 client.

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

Description

–ignore-changeview

Remove the changelist limit on depot paths. See ChangeView in p4 client.

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

Description

–ignore-changeview

Remove the changelist limit on depot paths. See ChangeView in p4 client.

impl Print<AttributeTraitMode>

pub fn get_attribute(&self) -> &str

Description

-T attribute

Print the value of the specified non-encoded attribute of the specified file.

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

Description

-T attribute

Print the value of the specified non-encoded attribute of the specified file.

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

Description

-T attribute

Print the value of the specified non-encoded attribute of the specified file.

pub fn get_all_revisions(&self) -> bool

Description

-a

For each file, print all revisions within a specified revision range, rather than only the highest revision in the range.

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

Description

-a

For each file, print all revisions within a specified revision range, rather than only the highest revision in the range.

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

Description

-a

For each file, print all revisions within a specified revision range, rather than only the highest revision in the range.

pub fn get_redirect_output(&self) -> Option<&PathBuf>

Description

-o localfile

Redirect output to the specified output file on the local disk, preserving the same file type, attributes, and/or permission bits as the original file in the depot.

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

Description

-o localfile

Redirect output to the specified output file on the local disk, preserving the same file type, attributes, and/or permission bits as the original file in the depot.

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

Description

-o localfile

Redirect output to the specified output file on the local disk, preserving the same file type, attributes, and/or permission bits as the original file in the depot.

pub fn get_quiet_mode(&self) -> bool

Description

-q

Suppress the one-line file header normally added by the Helix Core Server.

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

Description

-q

Suppress the one-line file header normally added by the Helix Core Server.

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

Description

-q

Suppress the one-line file header normally added by the Helix Core Server.

pub fn get_ignore_changeview(&self) -> bool

Description

–ignore-changeview

Remove the changelist limit on depot paths. See ChangeView in p4 client.

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

Description

–ignore-changeview

Remove the changelist limit on depot paths. See ChangeView in p4 client.

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

Description

–ignore-changeview

Remove the changelist limit on depot paths. See ChangeView in p4 client.

Trait Implementations

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

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

Formats the value using the given formatter.

impl<M: Default> Default for Print<M>

fn default() -> Self

Returns the “default value” for a type.

impl<M: ExclusiveOption> ParameterizedSpawn for Print<M>

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

Spawns p4 print for the given files 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 Input<'a> = &'a [&'a OsStr]

type Output<'a> = Child

type Error = Error

impl<M: ExclusiveOption> SubCommand for Print<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