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
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

use std::collections::BTreeMap;
use crate::drop::{
    source::Git,
    version::SemVer,
};

/// The value for the `meta` key in the drop manifest.
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "kebab-case")]
pub struct Meta {
    /// The drop's name.
    pub name: String,

    /// The pretty name displayed when viewing a drop.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub display_name: Option<String>,

    /// What is this drop?
    pub description: String,

    /// The path of the executable. `name` is used if `None`.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub exe_path: Option<String>,

    /// The licenses used.
    ///
    /// This can be a single license or multiple delimited by "AND" or "OR".
    #[serde(skip_serializing_if = "Option::is_none")]
    pub license: Option<String>,

    /// Authors of the drop.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub authors: Option<Vec<String>>,

    /// A path to the package's "README" file.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub readme: Option<String>,

    /// A path to the package's change log file.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub changelog: Option<String>,

    /// This drop's corner of the internet.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub homepage: Option<String>,

    /// The URL where docs live.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub documentation: Option<String>,

    /// The drop version.
    // TODO: Switch to a flexible versioning scheme that can parse `SemVer` with
    // any number of dots. If not `SemVer`, call it `Custom` and look into other
    // versioning schemes.
    // TODO: Consider accepting dates?
    pub version: SemVer,

    // Tables: all types that serialize into maps (or "tables" in TOML)
    // them must be placed last to succeed.

    /// The git repository where this drop can be fetched from.
    ///
    /// Repository info is taKen from here.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub git: Option<Git>,

    /// The versions that this version conflicts with.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub conflicts: Option<BTreeMap<String, String>>,
}

impl Meta {
    /// Returns the path where the executable is expected to be.
    pub fn exe_path(&self) -> &str {
        match &self.exe_path {
            Some(path) => path,
            None => &self.name,
        }
    }
}