Skip to main content

RevParseCommand

Struct RevParseCommand 

Source
pub struct RevParseCommand {
    pub executor: CommandExecutor,
    pub rev_args: Vec<String>,
    pub verify: bool,
    pub abbrev_ref: bool,
    pub short: Option<Option<u32>>,
    pub show_toplevel: bool,
    pub git_dir: bool,
    pub is_inside_work_tree: bool,
    pub is_bare_repository: bool,
    pub absolute_git_dir: bool,
}
Expand description

Builder for git rev-parse.

Fields§

§executor: CommandExecutor

Shared executor.

§rev_args: Vec<String>

Arguments / refs / flags to pass to rev-parse.

§verify: bool

--verify.

§abbrev_ref: bool

--abbrev-ref.

§short: Option<Option<u32>>

--short[=N].

§show_toplevel: bool

--show-toplevel.

§git_dir: bool

--git-dir.

§is_inside_work_tree: bool

--is-inside-work-tree.

§is_bare_repository: bool

--is-bare-repository.

§absolute_git_dir: bool

--absolute-git-dir.

Implementations§

Source§

impl RevParseCommand

Source

pub fn new() -> Self

New empty rev-parse command.

Source

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

Add a ref/rev string (e.g. "HEAD", "main", "HEAD~3").

Source

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

--verify: error if the argument is not a valid object.

Source

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

--abbrev-ref: print the short ref name.

Source

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

--short with default length.

Source

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

--short=N.

Source

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

--show-toplevel.

Source

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

--git-dir.

Source

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

--absolute-git-dir.

Source

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

--is-inside-work-tree.

Source

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

--is-bare-repository.

Trait Implementations§

Source§

impl Clone for RevParseCommand

Source§

fn clone(&self) -> RevParseCommand

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 RevParseCommand

Source§

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

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

impl Default for RevParseCommand

Source§

fn default() -> RevParseCommand

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

impl GitCommand for RevParseCommand

Source§

type Output = String

Trimmed stdout — typically a SHA, path, or true/false string.

Source§

fn get_executor(&self) -> &CommandExecutor

Borrow the shared executor.
Source§

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

Mutably borrow the shared executor.
Source§

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

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

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

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

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. Read more
Source§

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

Append a single raw argument.
Source§

fn args<I, S>(&mut self, args: I) -> &mut Self
where I: IntoIterator<Item = S>, S: AsRef<OsStr>,

Append several raw arguments.
Source§

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

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

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

Append a --key value pair.
Source§

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

Run git in the given working directory.
Source§

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

Set an environment variable for this invocation.
Source§

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

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

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

Convenience: set timeout in whole seconds.

Auto Trait Implementations§

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more