gog-sync 0.3.4

Synchronizes a GOG library with a local folder.
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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146

//! Loads and saves configuration as json files.
//!
//! Follows the [xdg](https://crates.io/crates/xdg) requirements and uses a
//! prefix of `gog-sync`.
//!
//! Uses [serde_json](https://crates.io/crates/serde_json) for serialization/deserialisation.

use serde::{Deserialize, Serialize};
use serde_json;
use std::fmt;
use std::fs::File;
use std;
use std::io::{Read, Write};
use xdg;
use xdg::BaseDirectories;
use std::path::Path;

/// Wraps `std::io::Error` and `serde_json::Error`.
#[derive(Debug)]
pub enum ConfigError {
    IOError(std::io::Error),
    SerdeJsonError(serde_json::Error),
}

impl fmt::Display for ConfigError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match *self {
            ConfigError::IOError(ref err) => fmt::Display::fmt(err, f),
            ConfigError::SerdeJsonError(ref err) => fmt::Display::fmt(err, f),
        }
    }
}

impl From<std::io::Error> for ConfigError {
    fn from(e: std::io::Error) -> Self {
        ConfigError::IOError(e)
    }
}

impl From<serde_json::Error> for ConfigError {
    fn from(e: serde_json::Error) -> Self {
        ConfigError::SerdeJsonError(e)
    }
}

pub struct ConfigFiles {
    xdg_dirs: BaseDirectories,
}

impl ConfigFiles {
    /// Create a new instance of `ConfigFiles`.
    /// This sets the xdg prefix to `gog-sync`.
    ///
    /// # Example
    /// ```
    /// use configfiles::ConfigFiles;
    ///
    /// let configfiles = ConfigFiles::new();
    /// ```
    pub fn new() -> ConfigFiles {
        let xdg_dirs = xdg::BaseDirectories::with_prefix("gog-sync").unwrap();
        ConfigFiles { xdg_dirs: xdg_dirs }
    }

    /// Load configuration from a json file.
    ///
    /// # Example
    /// ```
    /// use configfiles::ConfigFiles;
    ///
    /// #[derive(Serialize, Deserialize)]
    /// pub struct Config {
    ///     pub manual_url: String,
    /// }
    ///
    /// let configfiles = ConfigFiles::new();
    /// let config: Config = configfiles.load("config.json");
    /// ```
    pub fn load<T>(&self, name: &str) -> Result<T, ConfigError>
        where T: Deserialize
    {
        let config_path = self.xdg_dirs.place_config_file(name)?;
        let mut config_file = File::open(config_path)?;

        let mut config_contents = String::new();
        config_file.read_to_string(&mut config_contents)?;

        match serde_json::from_str(config_contents.as_str()) {
            Ok(value) => Ok(value),
            Err(error) => Err(ConfigError::SerdeJsonError(error)),
        }
    }

    /// Save configuration to a json file.
    ///
    /// # Example
    /// ```
    /// use configfiles::ConfigFiles;
    ///
    /// #[derive(Serialize, Deserialize)]
    /// pub struct Config {
    ///     pub manual_url: String,
    /// }
    ///
    /// let configfiles = ConfigFiles::new();
    /// let config: Config = configfiles.load("config.json");
    /// ```
    pub fn save<T>(&self, name: &str, content: &T) -> Result<(), ConfigError>
        where T: Serialize
    {
        let config_path = self.xdg_dirs.place_config_file(name)?;
        let content_toml = serde_json::to_string_pretty(content)?;

        let mut config_file = File::create(&config_path)?;
        match config_file.write_all(content_toml.as_bytes()) {
            Ok(_) => Ok(()),
            Err(error) => Err(ConfigError::IOError(error)),
        }
    }

    pub fn save_to_path<T>(path: &Path, content: &T) -> Result<(), ConfigError>
        where T: Serialize
    {
        let content_toml = serde_json::to_string_pretty(content)?;

        let mut config_file = File::create(path)?;
        match config_file.write_all(content_toml.as_bytes()) {
            Ok(_) => Ok(()),
            Err(error) => Err(ConfigError::IOError(error)),
        }
    }

    pub fn load_from_path<T>(path: &Path) -> Result<T, ConfigError>
        where T: Deserialize
    {
        let mut file = File::open(path)?;

        let mut contents = String::new();
        file.read_to_string(&mut contents)?;

        match serde_json::from_str(contents.as_str()) {
            Ok(value) => Ok(value),
            Err(error) => Err(ConfigError::SerdeJsonError(error)),
        }
    }
}