GitIntegration

scribe_core::traits

Trait GitIntegration 

Source 
pub trait GitIntegration: Send + Sync {
    // Required methods
    fn is_git_repository<'life0, 'life1, 'async_trait>(
        &'life0 self,
        path: &'life1 Path,
    ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn get_file_status<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 self,
        files: &'life1 [&'life2 Path],
    ) -> Pin<Box<dyn Future<Output = Result<Vec<GitStatus>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait,
             'life2: 'async_trait;
    fn get_repo_info<'life0, 'life1, 'async_trait>(
        &'life0 self,
        root_path: &'life1 Path,
    ) -> Pin<Box<dyn Future<Output = Result<GitRepositoryInfo>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn analyze_churn<'life0, 'life1, 'async_trait>(
        &'life0 self,
        root_path: &'life1 Path,
        depth: usize,
    ) -> Pin<Box<dyn Future<Output = Result<Vec<ChurnInfo>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn should_ignore<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 self,
        file_path: &'life1 Path,
        root_path: &'life2 Path,
    ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait,
             'life2: 'async_trait;
}
Expand description

Trait for git integration implementations

Required Methods§

Source

fn is_git_repository<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 Path, ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Check if path is in a git repository

Source

fn get_file_status<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, files: &'life1 [&'life2 Path], ) -> Pin<Box<dyn Future<Output = Result<Vec<GitStatus>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Get git status for files

Source

fn get_repo_info<'life0, 'life1, 'async_trait>( &'life0 self, root_path: &'life1 Path, ) -> Pin<Box<dyn Future<Output = Result<GitRepositoryInfo>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get repository information

Source

fn analyze_churn<'life0, 'life1, 'async_trait>( &'life0 self, root_path: &'life1 Path, depth: usize, ) -> Pin<Box<dyn Future<Output = Result<Vec<ChurnInfo>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Analyze file churn (commit history)

Source

fn should_ignore<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, file_path: &'life1 Path, root_path: &'life2 Path, ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Check if file should be ignored by git

Implementors§