Struct Subtrees

pub struct Subtrees { /* private fields */ }

Manages subtrees in a repository

Implementations

impl Subtrees

pub fn new() -> Result<Self, SubtreesError>

Errors

Throws SubtreesError if fails to find or access repository.

pub fn from_repo(repo: Repository) -> Result<Self, SubtreesError>

Discover subtrees in a git repository

pub fn from_dir(path: &Path) -> Result<Self, SubtreesError>

Discover subtrees in specified directory

pub fn add( &self, subtree: &SubtreeConfig, revision: Option<&str>, subject: Option<&str>, ) -> Result<(), AdditionError>

Add subtree to repository

Errors

Throws errors when there are errors

Panics

Panics when something unexpected happens

pub fn all(&self) -> Result<Vec<SubtreeConfig>, ConfigError>

Errors

Throws ConfigError if something goes wrong during parsing

pub fn head(&self) -> Option<String>

Returns the repository head commit id

pub fn pull( &self, subtree: &SubtreeConfig, git_ref: &str, ) -> Result<String, PullError>

Pull remote changes in the specified subtree

pub fn split(&self, subtree: &SubtreeConfig) -> Result<(), SplitError>

Split changes in a subtree to own artificial history and merge it back into HEAD

pub fn push( &self, subtree: &SubtreeConfig, git_ref: &str, ) -> Result<(), PushError>

Push subtree changes to remote

pub fn changed_modules( &self, id: &str, ) -> Result<Vec<SubtreeConfig>, ConfigError>

List modules with changes since specified git commit id

pub fn find_subtree(&self, needle: &str) -> Result<SubtreeConfig, FindError>

Find subtree by name

Trait Implementations

impl Debug for Subtrees

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

Formats the value using the given formatter.