CommitMessageGenerator

Trait CommitMessageGenerator 

Source
pub trait CommitMessageGenerator: Send + Sync {
    type Error: Error + Send + Sync + 'static;

    // Required methods
    fn generate_message<'life0, 'life1, 'async_trait>(
        &'life0 self,
        diff: &'life1 str,
    ) -> Pin<Box<dyn Future<Output = Result<String, Self::Error>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn validate_message(&self, message: &str) -> bool;
}
Expand description

Trait for commit message generators

Required Associated Types§

Source

type Error: Error + Send + Sync + 'static

The error type returned by this generator

Required Methods§

Source

fn generate_message<'life0, 'life1, 'async_trait>( &'life0 self, diff: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<String, Self::Error>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Generate a commit message from a diff

Source

fn validate_message(&self, message: &str) -> bool

Validate a commit message format

Implementors§

Source§

impl<T: ModelProvider> CommitMessageGenerator for T

Implementation of CommitMessageGenerator for any ModelProvider