Struct Info 

pub struct Info {
    pub dir: String,
    pub is_git: bool,
    pub branch: Option<String>,
    pub status: Option<Status>,
    pub commits: Option<Vec<Commit>>,
}

The main struct that returns combined Status and Commits info

Fields

dir: String

Repo directory

is_git: bool

Boolean indicating id the directory above is indeed a repo

branch: Option<String>

Repo branch inspected

status: Option<Status>

Status information for the repo

commits: Option<Vec<Commit>>

Information on the repo commits

Implementations

impl Info

pub fn new(dir: &str) -> Info

To initialize the Info Struct. A &str pointing to the repo directory is expected This implementation method checks that the directory does indeed exist and that the repo is a git repo It returns a new Info Struct with the “dir” and “is_git” fields set

Example

 // let dir = "/path/to/repo"; <- Point to the location of t=your repo
 let info = Info::new(&dir);
 println("{:#?}", info);

pub fn commit_info(&self) -> Result<Info>

Get information of all the commits. This Method returns Info in its result. If there are no commits, the returned value is None

Example

 // let dir = "/path/to/repo"; <- Point to the location of t=your repo
 let commits_info = Info::new(&dir).commit_info()?;
 println("{:#?}", commits_info);

pub fn status_info(&self) -> Result<Info>

This method returns status information for the repo

Example

 // let dir = "/path/to/repo"; <- Point to the location of t=your repo
 let status_info = Info::new(&dir).status_info()?;
 println("{:#?}", status_info);

Trait Implementations

impl Clone for Info

fn clone(&self) -> Info

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Info

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

Formats the value using the given formatter.