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

use std::collections::BTreeMap;
use crate::drop::{
    name::Query,
    source::Git,
};

/// A mapping from drop names to dependency specification information.
pub type Deps = BTreeMap<Query, DepInfo>;

flexible! {
    /// The value associated with an element listed in the `dependencies` key in the
    /// manifest.
    ///
    /// This is defined as an `enum` to allow for flexibility in parsing. Either a
    /// simple string will be parsed, in which case it's a version number
    /// (`Version`), or a list of key/value pairs will be parsed (`Detailed`).
    ///
    /// In the future, this should be defined as a `struct` to ease usage in Rust
    /// while retaining flexibility in parsing.
    #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize)]
    pub struct DepInfo {
        /// The version requirement string, e.g. `^1.0.0`.
        pub version: String,

        /// Whether the dependency is optional. The default is `false`.
        #[serde(default)]
        pub optional: bool,

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

        /// What git repository can it be fetched from if requested via git as
        /// an alternative source. Note that this may differ from the
        /// dependency's own `git` field in its drop manifest.
        #[serde(skip_serializing_if = "Option::is_none")]
        pub git: Option<Git>,
    }
}

impl From<String> for DepInfo {
    fn from(version: String) -> Self {
        Self {
            version,
            git: None,
            optional: false,
        }
    }
}