Struct FileLog 

pub struct FileLog<L = Unselected, H = Unselected> { /* private fields */ }

Print detailed information about the revisions of files.

The L type parameter tracks the changelist description output at compile time: Self::full_description transitions to the FullDescription state and Self::truncated_description transitions to the TruncatedDescription state. The H type parameter tracks whether file content history is displayed: Self::content_history transitions to the DisplayContentHistory state.

Implementations

impl FileLog<Unselected, Unselected>

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

Creates a new p4 filelog command.

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

impl<H: ExclusiveOption> FileLog<Unselected, H>

pub fn full_description(self) -> FileLog<FullDescription, H>

Description

-l

List long output, with the full text of each changelist description.

Transitions this command to the FullDescription state.

Examples found in repository

examples/filelog.rs (line 44)

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 truncated_description(self) -> FileLog<TruncatedDescription, H>

Description

-L

List long output, with the full text of each changelist description truncated at 250 characters.

Transitions this command to the TruncatedDescription state.

impl<L: ExclusiveOption> FileLog<L, Unselected>

pub fn content_history(self) -> FileLog<L, DisplayContentHistory>

Description

-h

Display file content history instead of file name history.

Transitions this command to the DisplayContentHistory state, which unlocks the -p option.

Examples found in repository

examples/filelog.rs (line 55)

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(())
}

impl<L: ExclusiveOption, H: ExclusiveOption> FileLog<L, H>

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.

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

Description

-c change

Display only files submitted at the specified changelist number.

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

Description

-c change

Display only files submitted at the specified changelist number.

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

Description

-c change

Display only files submitted at the specified changelist number.

Examples found in repository

examples/filelog.rs (line 57)

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

Description

-i

Follow file history across branches.

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

Description

-i

Follow file history across branches.

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

Description

-i

Follow file history across branches.

Examples found in repository

examples/filelog.rs (line 32)

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

Description

-m max

List only the first max changes per file output.

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

Description

-m max

List only the first max changes per file output.

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

Description

-m max

List only the first max changes per file output.

Examples found in repository

examples/filelog.rs (line 34)

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

Description

-s

Display a shortened form of output by ignoring non-contributory integrations.

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

Description

-s

Display a shortened form of output by ignoring non-contributory integrations.

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

Description

-s

Display a shortened form of output by ignoring non-contributory integrations.

pub fn get_include_time(&self) -> bool

Description

-t

Display the time as well as the date.

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

Description

-t

Display the time as well as the date.

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

Description

-t

Display the time as well as the date.

Examples found in repository

examples/filelog.rs (line 33)

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(())
}

impl<L: ExclusiveOption> FileLog<L, DisplayContentHistory>

pub fn get_skip_promoted_tasks(&self) -> bool

Description

-p

When used with the -h option, do not follow content of promoted task streams.

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

Description

-p

When used with the -h option, do not follow content of promoted task streams.

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

Description

-p

When used with the -h option, do not follow content of promoted task streams.

Examples found in repository

examples/filelog.rs (line 56)

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(())
}

Trait Implementations

impl<L: Clone, H: Clone> Clone for FileLog<L, H>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<L: Debug, H: Debug> Debug for FileLog<L, H>

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

Formats the value using the given formatter.

impl<L: Default, H: Default> Default for FileLog<L, H>

fn default() -> Self

Returns the “default value” for a type.

impl<L: ExclusiveOption, H: ExclusiveOption, S, I> ParameterizedSpawn<(S,)> for FileLog<L, H>

where S: IntoIterator<Item = I>, I: AsRef<OsStr>,

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

Spawns p4 filelog 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.

At least one file or file pattern must be provided.

type Output = Child

type Error = Error

impl<L: ExclusiveOption, H: ExclusiveOption> SubCommand for FileLog<L, H>

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