midenup 1.0.0

The Miden toolchain 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

use std::{path::PathBuf, time::SystemTime};

use serde::{Deserialize, Serialize};

use crate::version::GitTarget;

/// Represents the canonical versioning authority for a tool or toolchain
#[derive(Serialize, Deserialize, Debug, Clone, Hash)]
#[serde(untagged, rename_all = "snake_case")]
pub enum Authority {
    /// The authority for this tool/toolchain is a local filesystem path
    Path {
        /// The path to the crate.
        path: PathBuf,
        crate_name: String,
        /// Represents the latest modification done inside this directory.
        #[serde(skip_serializing_if = "Option::is_none")]
        last_modification: Option<SystemTime>,
    },
    /// The authority for this tool/toolchain is a git repository.
    Git {
        crate_name: String,
        /// Points to the git repository containting the [crate::channel::Component].
        repository_url: String,
        /// The subdirectory within the repository which contains the component
        ///
        /// This is only required for components which are not crates
        #[serde(skip_serializing_if = "Option::is_none")]
        subpath: Option<String>,
        /// If the target is missing from the [crate::manifest::Manifest], then we assume that it
        /// is pointing to the tip of the `main` branch
        #[serde(default)]
        #[serde(flatten)]
        target: GitTarget,
    },
    /// The authority for this tool/toolchain is crates.io
    Cargo {
        #[serde(skip_serializing_if = "Option::is_none")]
        package: Option<String>,
        /// The semantic versioning string for the package to fetch
        version: semver::Version,
    },
}

impl From<Authority> for crate::version::Authority {
    fn from(value: Authority) -> Self {
        match value {
            Authority::Path { path, last_modification, crate_name: _ } => {
                Self::Path { path, last_modification }
            },
            Authority::Git {
                repository_url,
                subpath,
                target,
                crate_name: _,
            } => Self::Git { repository_url, subpath, target },
            Authority::Cargo { version, package: _ } => Self::Registry { version },
        }
    }
}