Struct Config

pub struct Config {
    pub default_provider: String,
    pub providers: HashMap<String, ProviderConfig>,
    pub use_gitmoji: bool,
    pub instructions: String,
    pub instruction_preset: String,
    pub temp_instructions: Option<String>,
    pub temp_preset: Option<String>,
    pub is_project_config: bool,
}

Configuration structure for the Git-Iris application

Fields

default_provider: String

Default LLM provider

providers: HashMap<String, ProviderConfig>

Provider-specific configurations

use_gitmoji: bool

Flag indicating whether to use Gitmoji

instructions: String

Instructions for commit messages

instruction_preset: String

temp_instructions: Option<String>

temp_preset: Option<String>

is_project_config: bool

Flag indicating if this config is from a project file

Implementations

impl Config

pub fn load() -> Result<Self>

Load the configuration from the file

pub fn load_project_config() -> Result<Self, Error>

Load project-specific configuration

pub fn get_project_config_path() -> Result<PathBuf, Error>

Get the path to the project configuration file

pub fn merge_with_project_config(&mut self, project_config: Self)

Merge this config with project-specific config, with project config taking precedence But never allow API keys from project config

pub fn save(&self) -> Result<()>

Save the configuration to the file

pub fn save_as_project_config(&self) -> Result<(), Error>

Save the configuration as a project-specific configuration

pub fn check_environment(&self) -> Result<()>

Check the environment for necessary prerequisites

pub fn set_temp_instructions(&mut self, instructions: Option<String>)

pub fn set_temp_preset(&mut self, preset: Option<String>)

pub fn get_effective_instructions(&self) -> String

pub fn update( &mut self, provider: Option<String>, api_key: Option<String>, model: Option<String>, additional_params: Option<HashMap<String, String>>, use_gitmoji: Option<bool>, instructions: Option<String>, token_limit: Option<usize>, ) -> Result<()>

Update the configuration with new values

pub fn get_provider_config(&self, provider: &str) -> Option<&ProviderConfig>

Get the configuration for a specific provider

pub fn set_project_config(&mut self, is_project: bool)

Set whether this config is a project config

pub fn is_project_config(&self) -> bool

Check if this is a project config

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Config

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.