chatti 0.1.0

Terminal-based chat application that interfaces with Ollama
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

use serde::{Deserialize, Serialize};
use std::{fs, path::PathBuf};

/// Configuration structure for the Chatti application.
///
/// This struct holds the configuration parameters for the application,
/// including API endpoint, model name, streaming flag, and temperature.
#[derive(Debug, Serialize, Deserialize, Clone)]
pub struct Config {
    /// The API endpoint for the chat service.
    pub api_endpoint: String,
    /// The name of the model to use for chat.
    pub model: String,
    /// Whether to use streaming for responses.
    pub stream: bool,
    /// The temperature parameter for text generation.
    pub temperature: f32,
}

impl Config {
    /// Loads the configuration from a file.
    ///
    /// This function attempts to load the configuration from a TOML file
    /// located at `~/.config/chatti/config.toml`. If the file doesn't exist,
    /// it creates a default configuration file.
    ///
    /// # Returns
    ///
    /// Returns a `Result` containing either the loaded `Config` or a `FSError`.
    ///
    /// # Errors
    ///
    /// This function will return an error in the following situations:
    /// - `FSError::HomeDirNotFound`: If the home directory cannot be found.
    /// - `FSError::IoError`: If there's an I/O error while creating directories,
    ///   reading from, or writing to the configuration file.
    /// - `FSError::TomlParseError`: If the configuration file exists but contains
    ///   invalid TOML syntax.
    /// - `FSError::TomlSerializeError`: If there's an error serializing the default
    ///   configuration to TOML format when creating a new configuration file.
    ///
    /// # Examples
    ///
    /// ```rust
    /// use chatti::config::Config;
    ///
    /// # fn main() -> Result<(), Box<dyn std::error::Error>> {
    /// let config = Config::load()?;
    /// println!("API Endpoint: {}", config.api_endpoint);
    /// # Ok(())
    /// # }
    /// ```
    pub fn load() -> Result<Self, FSError> {
        let config_dir = dirs::home_dir()
            .ok_or(FSError::HomeDirNotFound)?
            .join(".config")
            .join("chatti");

        fs::create_dir_all(&config_dir).map_err(FSError::IoError)?;

        let config_path = config_dir.join("config.toml");

        if !config_path.exists() {
            Self::create_default_config(&config_path)?;
        }

        let config_content = fs::read_to_string(&config_path).map_err(FSError::IoError)?;
        let config: Config = toml::from_str(&config_content).map_err(FSError::TomlParseError)?;

        Ok(config)
    }

    /// Creates a default configuration file.
    ///
    /// This function is called when the configuration file doesn't exist.
    /// It creates a new file with default values.
    ///
    /// # Arguments
    ///
    /// * `path` - A reference to the `PathBuf` where the config file should be created.
    ///
    /// # Returns
    ///
    /// Returns a `Result` indicating success or a `FSError`.
    fn create_default_config(path: &PathBuf) -> Result<(), FSError> {
        let default_config = Config {
            api_endpoint: String::new(),
            model: String::new(),
            stream: false,
            temperature: 0.7,
        };

        let toml_string = toml::to_string(&default_config).map_err(FSError::TomlSerializeError)?;
        fs::write(path, toml_string).map_err(FSError::IoError)?;

        Ok(())
    }
}

/// Represents errors that can occur during configuration operations.
#[derive(Debug, thiserror::Error)]
pub enum FSError {
    /// Error when the home directory cannot be found.
    #[error("home directory not found")]
    HomeDirNotFound,

    /// Error during I/O operations.
    #[error("IO error: {0}")]
    IoError(#[from] std::io::Error),

    /// Error when parsing TOML content.
    #[error("TOML parse error: {0}")]
    TomlParseError(#[from] toml::de::Error),

    /// Error when serializing to TOML.
    #[error("Toml serialize error: {0}")]
    TomlSerializeError(#[from] toml::ser::Error),
}