| //! This module contains `Dependency` and the types/functions it uses for deserialization. |
| |
| use std::fmt; |
| |
| use camino::Utf8PathBuf; |
| #[cfg(feature = "builder")] |
| use derive_builder::Builder; |
| use semver::VersionReq; |
| use serde::{Deserialize, Deserializer, Serialize}; |
| |
| #[derive(Eq, PartialEq, Clone, Debug, Copy, Hash, Serialize, Deserialize)] |
| /// Dependencies can come in three kinds |
| pub enum DependencyKind { |
| #[serde(rename = "normal")] |
| /// The 'normal' kind |
| Normal, |
| #[serde(rename = "dev")] |
| /// Those used in tests only |
| Development, |
| #[serde(rename = "build")] |
| /// Those used in build scripts only |
| Build, |
| #[doc(hidden)] |
| #[serde(other)] |
| Unknown, |
| } |
| |
| impl Default for DependencyKind { |
| fn default() -> DependencyKind { |
| DependencyKind::Normal |
| } |
| } |
| |
| impl fmt::Display for DependencyKind { |
| fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { |
| let s = serde_json::to_string(self).unwrap(); |
| // skip opening and closing quotes |
| f.write_str(&s[1..s.len() - 1]) |
| } |
| } |
| |
| /// The `kind` can be `null`, which is interpreted as the default - `Normal`. |
| pub(super) fn parse_dependency_kind<'de, D>(d: D) -> Result<DependencyKind, D::Error> |
| where |
| D: Deserializer<'de>, |
| { |
| Deserialize::deserialize(d).map(|x: Option<_>| x.unwrap_or_default()) |
| } |
| |
| #[derive(Clone, Serialize, Deserialize, Debug, PartialEq, Eq)] |
| #[cfg_attr(feature = "builder", derive(Builder))] |
| #[non_exhaustive] |
| #[cfg_attr(feature = "builder", builder(pattern = "owned", setter(into)))] |
| /// A dependency of the main crate |
| pub struct Dependency { |
| /// Name as given in the `Cargo.toml` |
| pub name: String, |
| /// The source of dependency |
| pub source: Option<String>, |
| /// The required version |
| pub req: VersionReq, |
| /// The kind of dependency this is |
| #[serde(deserialize_with = "parse_dependency_kind")] |
| pub kind: DependencyKind, |
| /// Whether this dependency is required or optional |
| pub optional: bool, |
| /// Whether the default features in this dependency are used. |
| pub uses_default_features: bool, |
| /// The list of features enabled for this dependency. |
| pub features: Vec<String>, |
| /// The target this dependency is specific to. |
| /// |
| /// Use the [`Display`] trait to access the contents. |
| /// |
| /// [`Display`]: std::fmt::Display |
| pub target: Option<Platform>, |
| /// If the dependency is renamed, this is the new name for the dependency |
| /// as a string. None if it is not renamed. |
| pub rename: Option<String>, |
| /// The URL of the index of the registry where this dependency is from. |
| /// |
| /// If None, the dependency is from crates.io. |
| pub registry: Option<String>, |
| /// The file system path for a local path dependency. |
| /// |
| /// Only produced on cargo 1.51+ |
| pub path: Option<Utf8PathBuf>, |
| } |
| |
| pub use cargo_platform::Platform; |