Function git_status_vars::summarize_opened_repository
source · pub fn summarize_opened_repository<W: Write>(
out: &ShellWriter<W>,
repository: &Repository
) -> Result<(), Error>
Expand description
Summarize information about a successfully opened repository.
§Example
use git_status_vars::{summarize_opened_repository, ShellWriter};
use git2::Repository;
summarize_opened_repository(
&ShellWriter::default(),
&Repository::open_from_env().unwrap(),
).unwrap();
§Errors
This will return a git2::Error
if there were problems getting repository
information. This is careful to load all repository information (and thus
encountering any errors) before generating any output.
§Panics
This may panic if it can’t resolve a symbolic reference to a symbolic target.