Interface Vcs

mit-commit-message-lints/src/external/vcs.rs:7–41

A wrapper around accessing different values from a VCS config

/// A wrapper around accessing different values from a VCS config
pub trait Vcs {
    /// # Errors
    ///
    /// If we can't read the config entries
    fn entries(&self, glob: Option<&str>) -> Result<Vec<String>>;
    /// # Errors
    ///
    /// If we can't read the config, or it's not parsable into a bool
    fn get_bool(&self, name: &str) -> Result<Option<bool>>;
    /// # Errors
    ///
    /// If we can't read the config, or it's not parsable into a &str
    fn get_str(&self, name: &str) -> Result<Option<&str>>;
    /// # Errors
    ///
    /// If we can't read the config, or it's not parsable into an i64
    fn get_i64(&self, name: &str) -> Result<Option<i64>>;
    /// # Errors
    ///
    /// If the config fails to write
    fn set_str(&mut self, name: &str, value: &str) -> Result<()>;
    /// # Errors
    ///
    /// If the config fails to write
    fn set_i64(&mut self, name: &str, value: i64) -> Result<()>;
    /// # Errors
    ///
    /// If the config fails to write
    fn remove(&mut self, name: &str) -> Result<()>;

    /// The state of the repository currently
    ///
    /// None if there is no repository, and we only have config
    fn state(&self) -> Option<RepoState>;
}

/// State of the repository
#[derive(Debug, Copy, Clone)]