Struct skellige::prelude::git::Repo

pub struct Repo<'a> { /* fields omitted */ }

Git repository

Implementations

impl<'a> Repo<'a>

pub fn branch_val(&self) -> Option<&str>

Returns the target branch for this repo. Defaults to master internally when not set.

Examples

use skellige::prelude::*;

assert_eq!(git::Repo::new("foo").unwrap().branch("foobar").branch_val(), Some("foobar"));

pub fn branch_only_val(&self) -> bool

Returns the branch flag's value for this repo.

Examples

use skellige::prelude::*;

assert_eq!(git::Repo::new("foo").unwrap().branch_only(true).branch_only_val(), true);

pub fn path_val(&self) -> &Path

Returns the local location on disk for this repo

Examples

use skellige::prelude::*;

assert_eq!(git::Repo::new("foo").unwrap().path_val(), Path::new("foo").abs().unwrap().as_path());

pub fn url_val(&self) -> Option<&str>

Returns the remote location for this repo

Examples

use skellige::prelude::*;

assert_eq!(git::Repo::new("foo").unwrap().url("foobar").url_val(), Some("foobar"));

pub fn branch<T>(self, branch: T) -> Self where
    T: AsRef<str>, 

Set the branch to target for this repo

Examples

use skellige::prelude::*;

assert_eq!(git::Repo::new("foo").unwrap().branch("foobar").branch_val(), Some("foobar"));

pub fn branch_only(self, yes: bool) -> Self

Set to target the branch only and not the entire repo.

Examples

use skellige::prelude::*;

assert_eq!(git::Repo::new("foo").unwrap().branch_only(true).branch_only_val(), true);

pub fn url<T>(self, url: T) -> Self where
    T: AsRef<str>, 

Set the remote location for this repo

Examples

use skellige::prelude::*;

git::Repo::new("foo").unwrap().url("foobar");

pub fn xfer_progress<T>(self, func: T) -> Self where
    T: FnMut(u64, u64) + 'a, 

Set the transfer progress callback to use.

Examples

use skellige::prelude::*;

git::Repo::new("foo").unwrap().url("foobar");

pub fn checkout_progress<T>(self, func: T) -> Self where
    T: FnMut(u64, u64) + 'a, 

Set the checkout progress callback to use.

Examples

use skellige::prelude::*;

git::Repo::new("foo").unwrap().url("foobar");

pub fn update_progress<T>(self, func: T) -> Self where
    T: FnMut(u64, u64) + 'a, 

Set the update progress callback to use.

Examples

use skellige::prelude::*;

git::Repo::new("foo").unwrap().url("foobar");

pub fn new<T>(path: T) -> Result<Self> where
    T: AsRef<Path>, 

Create a new repo instance based on the given path

Examples

use skellige::prelude::*;

assert!(git::Repo::new("foo").is_ok());

pub fn last_msg(&self) -> Result<String>

Returns the message from the head commit.

Examples

use skellige::prelude::*;

let tmpdir = PathBuf::from("tests/temp").abs().unwrap().mash("git_repo_last_msg_doc");
assert!(sys::remove_all(&tmpdir).is_ok());
let tarball = tmpdir.mash("../../alpine-base.tgz");
assert!(tar::extract_all(&tarball, &tmpdir).is_ok());
assert_eq!(git::Repo::new(&tmpdir).unwrap().last_msg().unwrap(), "Use the workflow name for the badge".to_string());
assert!(sys::remove_all(&tmpdir).is_ok());

pub fn clone(self) -> Result<PathBuf>

Clone the repo locally. Clones the entire repo unless branch_only is set to true. Calling this function consumes any progress callbacks you may have set.

Examples

use skellige::prelude::*;

let tmpdir = PathBuf::from("tests/temp").abs().unwrap().mash("git_repo_clone_doc");
assert!(sys::remove_all(&tmpdir).is_ok());
assert!(sys::mkdir(&tmpdir).is_ok());
let tmpfile = tmpdir.mash("README.md");
assert_eq!(tmpfile.exists(), false);
assert!(git::Repo::new(&tmpdir).unwrap().url("https://github.com/phR0ze/alpine-base").clone().is_ok());
assert_eq!(tmpfile.exists(), true);
assert!(sys::remove_all(&tmpdir).is_ok());

pub fn update(self) -> Result<PathBuf>

Update the given repo, cloning the repo if it doesn't exist.

Examples

use skellige::prelude::*;

let tmpdir = PathBuf::from("tests/temp").abs().unwrap().mash("git_repo_update_doc");
assert!(sys::remove_all(&tmpdir).is_ok());
assert!(sys::mkdir(&tmpdir).is_ok());
let tmpfile = tmpdir.mash("README.md");
assert_eq!(tmpfile.exists(), false);
assert!(git::Repo::new(&tmpdir).unwrap().url("https://github.com/phR0ze/alpine-base").update().is_ok());
assert_eq!(tmpfile.exists(), true);
assert!(sys::remove_all(&tmpdir).is_ok());

Trait Implementations

impl<'a> Default for Repo<'a>

pub fn default() -> Repo<'a>

Returns the "default value" for a type.