Struct LogCommand 

pub struct LogCommand {

    pub executor: CommandExecutor,
    pub max_count: Option<u32>,
    pub skip: Option<u32>,
    pub oneline: bool,
    pub graph: bool,
    pub all: bool,
    pub reverse: bool,
    pub format: Option<String>,
    pub since: Option<String>,
    pub until: Option<String>,
    pub author: Option<String>,
    pub grep: Option<String>,
    pub revisions: Vec<String>,
    pub paths: Vec<String>,
}

Builder for git log.

Fields

executor: CommandExecutor

Shared executor.

max_count: Option<u32>

-n.

skip: Option<u32>

--skip.

oneline: bool

--oneline.

graph: bool

--graph.

all: bool

--all.

reverse: bool

--reverse.

format: Option<String>

--format / --pretty=format:.

since: Option<String>

--since.

until: Option<String>

--until.

author: Option<String>

--author.

grep: Option<String>

--grep.

revisions: Vec<String>

Revision range (e.g. HEAD~5..HEAD) or refs.

paths: Vec<String>

Pathspec filters.

Implementations

impl LogCommand

pub fn new() -> Self

New log builder.

pub fn max_count(&mut self, n: u32) -> &mut Self

Limit to n commits.

pub fn skip(&mut self, n: u32) -> &mut Self

Skip first n commits.

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

--oneline.

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

--graph.

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

--all.

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

--reverse.

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

Set a --format=... template.

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

Filter by --since.

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

Filter by --until.

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

Filter by author.

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

Filter by commit-message grep.

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

Add a revision/range/ref.

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

Filter by path.

Trait Implementations

impl Clone for LogCommand

fn clone(&self) -> LogCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LogCommand

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

Formats the value using the given formatter.

impl Default for LogCommand

fn default() -> LogCommand

Returns the “default value” for a type.

impl GitCommand for LogCommand

type Output = CommandOutput

The typed output produced by this command.

fn get_executor(&self) -> &CommandExecutor

Borrow the shared executor.

fn get_executor_mut(&mut self) -> &mut CommandExecutor

Mutably borrow the shared executor.

fn build_command_args(&self) -> Vec<String>

Build the full argument vector (subcommand + flags + positionals) excluding the leading git program.

fn execute<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<CommandOutput>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Run the command and decode its output into Self::Output.

fn execute_raw<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<CommandOutput>> + Send + 'async_trait>>

where Self: Sync + 'async_trait, 'life0: 'async_trait,

Spawn git with the given arguments and return the raw output.

fn arg<S: AsRef<OsStr>>(&mut self, arg: S) -> &mut Self

Append a single raw argument.

fn args<I, S>(&mut self, args: I) -> &mut Self

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

Append several raw arguments.

fn flag(&mut self, flag: &str) -> &mut Self

Append a --flag (or -f if a single character).

fn option(&mut self, key: &str, value: &str) -> &mut Self

Append a --key value pair.

fn current_dir<P: Into<PathBuf>>(&mut self, dir: P) -> &mut Self

Run git in the given working directory.

fn env<K: Into<OsString>, V: Into<OsString>>( &mut self, key: K, value: V, ) -> &mut Self

Set an environment variable for this invocation.

fn with_timeout(&mut self, timeout: Duration) -> &mut Self

Cap execution time. On expiry the process is killed and Error::Timeout is returned.

fn with_timeout_secs(&mut self, seconds: u64) -> &mut Self

Convenience: set timeout in whole seconds.