scarb 0.5.2

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

use std::fmt;
use std::ops::Deref;
use std::sync::Arc;

use anyhow::{anyhow, Result};
use camino::{Utf8Path, Utf8PathBuf};
use serde::Deserialize;

pub use id::*;
pub use name::*;

use crate::compiler::Profile;
use crate::core::manifest::Manifest;
use crate::core::Target;

mod id;
mod name;

/// See [`PackageInner`] for public fields reference.
#[derive(Clone, Debug)]
pub struct Package(Arc<PackageInner>);

#[derive(Debug)]
#[non_exhaustive]
pub struct PackageInner {
    pub id: PackageId,
    pub manifest: Box<Manifest>,
    manifest_path: Utf8PathBuf,
}

impl Deref for Package {
    type Target = PackageInner;

    fn deref(&self) -> &Self::Target {
        self.0.deref()
    }
}

#[derive(Copy, Clone, Debug, Eq, PartialEq, Ord, PartialOrd, Hash)]
pub enum PackageClass {
    Library,
    CairoPlugin,
    Other,
}

impl Package {
    pub fn new(id: PackageId, manifest_path: Utf8PathBuf, manifest: Box<Manifest>) -> Self {
        Self(Arc::new(PackageInner {
            id,
            manifest_path,
            manifest,
        }))
    }

    pub fn root(&self) -> &Utf8Path {
        self.manifest_path
            .parent()
            .expect("manifest path parent must always exist")
    }

    pub fn manifest_path(&self) -> &Utf8Path {
        &self.manifest_path
    }

    pub fn is_lib(&self) -> bool {
        self.manifest.targets.iter().any(Target::is_lib)
    }

    pub fn is_cairo_plugin(&self) -> bool {
        self.manifest.targets.iter().any(Target::is_cairo_plugin)
    }

    pub fn classify(&self) -> PackageClass {
        if self.is_cairo_plugin() {
            PackageClass::CairoPlugin
        } else if self.is_lib() {
            PackageClass::Library
        } else {
            PackageClass::Other
        }
    }

    pub fn target(&self, kind: &str) -> Option<&Target> {
        self.manifest.targets.iter().find(|t| t.kind == kind)
    }

    pub fn fetch_target(&self, kind: &str) -> Result<&Target> {
        self.target(kind)
            .ok_or_else(|| anyhow!("package `{self}` has no target `{kind}`"))
    }

    pub fn has_profile(&self, profile: &Profile) -> bool {
        self.manifest.profiles.contains(profile)
    }

    pub fn has_tool_metadata(&self, tool_name: &str) -> bool {
        self.tool_metadata(tool_name).is_some()
    }

    pub fn tool_metadata(&self, tool_name: &str) -> Option<&toml::Value> {
        self.manifest
            .metadata
            .tool_metadata
            .as_ref()?
            .get(tool_name)
    }

    pub fn fetch_tool_metadata(&self, tool_name: &str) -> Result<&toml::Value> {
        self.tool_metadata(tool_name)
            .ok_or_else(|| anyhow!("package manifest `{self}` has no [tool.{tool_name}] section"))
    }

    pub fn fetch_tool_metadata_as<T: Deserialize<'static>>(&self, tool_name: &str) -> Result<T> {
        let toml_value = self.fetch_tool_metadata(tool_name)?;
        let structured = toml_value.clone().try_into()?;
        Ok(structured)
    }
}

impl fmt::Display for Package {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.id)
    }
}