Git

Struct Git 

Source
pub struct Git { /* private fields */ }
Expand description

git struct - the core of rsgit

to initialize, see Git::new

Implementations§

Source§

impl Git

Source

pub fn new<T>(items: T) -> Git
where T: IntoIterator, T::Item: ToString,

Creates a new instance of the Git structure

The provided items must be able to be coerced into a Vec<String>

Returned is an instance of the Git struct

§Examples
use rsgit::Git;
let cmd = Git::new(vec!["log", "--shortstat"]);
Source

pub fn stream(&self) -> Result<Success, Failure>

Runs the specified commands, prefixed by git

Returns either success or failure

stdin, stdout and stderr are all inherited from the parent

§Examples
use rsgit::{IsFailure, Git};
let cmd = Git::new(vec!["log", "--shortstat"]);
let output = cmd.stream();
println!("git log --shortstat returned code {}", output.code());
Source

pub fn run(&self) -> Result<Success, Failure>

Runs the specified commands, prefixed by git

Returns either success or failure

stdin, stdout and stderr are all returned in an object

§Examples
use rsgit::{IsFailure, Git};
let cmd = Git::new(vec!["log", "--shortstat"]);
let output = cmd.run();
println!("The output of git log --shortstat was {}", output.stdout().unwrap_or_default());

Auto Trait Implementations§

§

impl Freeze for Git

§

impl RefUnwindSafe for Git

§

impl Send for Git

§

impl Sync for Git

§

impl Unpin for Git

§

impl UnwindSafe for Git

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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.