oceanpkg 0.0.11

Client library for the Ocean package manager.
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

use std::path::PathBuf;
use shared::ext::PathBufExt;
use super::DirError;

/// Indicates where to (un)install a drop.
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
pub enum InstallTarget {
    /// Installation available for the current user; the default.
    ///
    /// In most places, it is usually assumed that this is what's wanted.
    CurrentUser,
    /// Installation available for a user, specified by a name.
    ///
    /// On the command-line, this is specified by the `--user`/`-u` flag.
    SpecificUser(String),
    /// Globally-available installation.
    ///
    /// On the command-line, this is specified by the `--global`/`-g` flag.
    Global,
}

impl Default for InstallTarget {
    #[inline]
    fn default() -> Self {
        InstallTarget::CurrentUser
    }
}

impl InstallTarget {
    /// Returns the configuration files directory for the installation target.
    ///
    /// # Examples
    ///
    /// For `InstallTarget::CurrentUser`, some expected outputs are:
    ///
    /// - Windows: `C:\Users\Alice\AppData\Roaming\Ocean`
    /// - macOS:   `/Users/Alice/Library/Preferences/Ocean`
    /// - Linux:   `/home/alice/.config`
    pub fn cfg_dir(&self) -> Result<PathBuf, DirError> {
        match self {
            Self::CurrentUser => {
                dirs::config_dir()
                    .ok_or(DirError::CurrentUserConfigDir)
                    .map(|cfg| cfg.pushing("Ocean"))
            },
            Self::SpecificUser(username) => {
                unimplemented!("TODO: Get config directory for {:?}", username);
            },
            Self::Global => {
                unimplemented!("TODO: Get global config directory");
            },
        }
    }
}