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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
use std::{
collections::{BTreeSet, HashMap},
fmt,
path::PathBuf,
};
use serde::{Deserialize, Serialize};
use super::{Component, ComponentKind};
use crate::{
channel::{ChannelAlias, UpstreamChannel, UpstreamMatch},
config::Config,
exec::Executable,
manifest::{Alias, ManifestError, v2::unknown::Extra},
};
/// Represents a specific release channel for a toolchain.
///
/// Different channels have different stability guarantees. See the specific details for the
/// channel you are interested in to learn more.
#[derive(Serialize, Deserialize, Debug, Clone, Hash)]
pub struct Channel {
/// Channels are identified by their name. The name corresponds to the channel's version.
/// The version can contain suffixes such as "-custom", "-beta".
pub name: semver::Version,
/// This is used to tag special channels. Most notably, the current "stable" channel is marked
/// with the [`ChannelAlias::Stable`] alias.
#[serde(skip_serializing_if = "Option::is_none")]
pub alias: Option<ChannelAlias>,
/// The channel this one supersedes, if any.
///
/// An installation of the named channel is carried here when it is updated: intent transfers
/// verbatim, `var/` is renamed so client data follows, and the old publication is removed once
/// the new state record commits (spec section 11.4).
///
/// Replaces the v1 `tags: [{ migration: { old_channel } }]` array. Migration is a property of
/// the *upstream* channel, and expressing it as one field rather than as a member of an
/// open-ended tag list means it can be found without pattern-matching over unrelated values.
/// The other tag, `partial`, described local state and is now derived (section 8.6).
#[serde(default, skip_serializing_if = "Option::is_none")]
pub migrates_from: Option<semver::Version>,
/// The set of toolchain components available in this channel
pub components: Vec<Component>,
/// Fields declared by a newer schema that this build does not recognize.
///
/// Safe to derive here: `Channel` has no other flattened field.
#[serde(flatten)]
pub extra: Extra,
}
impl Channel {
pub fn new(
name: semver::Version,
alias: Option<ChannelAlias>,
components: Vec<Component>,
) -> Self {
Self {
name,
alias,
components,
migrates_from: None,
extra: Extra::new(),
}
}
pub fn get_component(&self, name: impl AsRef<str>) -> Option<&Component> {
let name = name.as_ref();
self.components.iter().find(|c| c.name == name)
}
pub fn get_component_mut(&mut self, name: impl AsRef<str>) -> Option<&mut Component> {
let name = name.as_ref();
self.components.iter_mut().find(|c| c.name == name)
}
/// Is this channel a stable release? Does not imply that it has the `stable` alias.
///
/// To find out the latest stable [Channel], use [crate::manifest::Manifest::get_latest_stable].
pub fn is_stable(&self) -> bool {
self.alias.as_ref().is_none_or(|alias| matches!(alias, ChannelAlias::Stable))
}
pub fn is_nightly(&self) -> bool {
self.alias
.as_ref()
.is_some_and(|alias| matches!(alias, ChannelAlias::Nightly(_)))
}
/// Whether this channel installs only part of what `complete` would.
///
/// Derived, never recorded (spec section 8.6): local state has no "partial" flag, because one
/// would be a second answer to a question the component set already answers -- and the two
/// drifted apart, which is how a partially installed channel came to suppress every new
/// component during updates.
pub fn is_partially_installed(&self, upstream: &Channel) -> bool {
self.components.len() < upstream.components.len()
}
pub fn is_latest_nightly(&self) -> bool {
self.alias
.as_ref()
.is_some_and(|alias| matches!(alias, ChannelAlias::Nightly(None)))
}
pub fn get_channel_dir(&self, config: &Config) -> PathBuf {
let installed_toolchains_dir = config.midenup_home.join("toolchains");
installed_toolchains_dir.join(format!("{}", self.name))
}
/// Get all the alias names that the Channel is aware of
pub fn get_alias_names(&self) -> BTreeSet<Alias> {
self.components
.iter()
.flat_map(|c| match c.kind() {
ComponentKind::Command { aliases, .. } => {
aliases.keys().cloned().collect::<Vec<_>>()
},
ComponentKind::CargoExtension { spec, .. }
| ComponentKind::Executable { spec, .. } => {
spec.aliases.keys().cloned().collect::<Vec<_>>()
},
ComponentKind::Asset
| ComponentKind::Package
| ComponentKind::LegacyPackage { .. }
| ComponentKind::Unsupported { .. } => vec![],
})
.collect()
}
/// Get all the aliases that the Channel is aware of
pub fn get_aliases(&self) -> Result<HashMap<Alias, Executable>, ManifestError> {
use std::collections::hash_map::Entry;
let mut aliases = HashMap::new();
let mut alias_definitions = HashMap::new();
for component in self.components.iter() {
match component.kind() {
ComponentKind::CargoExtension { spec, .. }
| ComponentKind::Executable { spec, .. } => {
for (alias, exe) in spec.aliases.iter() {
match aliases.entry(alias.clone()) {
Entry::Vacant(entry) => {
alias_definitions.insert(alias.as_str(), component.name.clone());
entry.insert(exe.clone());
},
Entry::Occupied(_) => {
let prev = alias_definitions[alias.as_str()].to_string();
return Err(ManifestError::ConflictingAlias {
prev_component: prev,
component: component.name.to_string(),
alias: alias.clone(),
});
},
}
}
},
ComponentKind::Command {
command_name: name,
format,
aliases: command_aliases,
..
} => {
let name = name.as_deref().unwrap_or(component.name.as_ref());
for (alias, exe) in core::iter::once((name, format))
.chain(command_aliases.iter().map(|(k, v)| (k.as_str(), v)))
{
match aliases.entry(alias.to_string()) {
Entry::Vacant(entry) => {
alias_definitions.insert(alias, component.name.clone());
entry.insert(exe.clone());
},
Entry::Occupied(_) => {
let prev = alias_definitions[alias].to_string();
return Err(ManifestError::ConflictingAlias {
prev_component: prev,
component: component.name.to_string(),
alias: alias.to_string(),
});
},
}
}
},
ComponentKind::Asset
| ComponentKind::Package
| ComponentKind::LegacyPackage { .. }
| ComponentKind::Unsupported { .. } => (),
}
}
Ok(aliases)
}
/// Finds the upstream channel this one corresponds to.
///
/// Either they share a version, or an upstream channel declares `migrates_from: <this
/// channel>`. A same-version match wins: a channel that still exists upstream is not migrated
/// away from, whatever some other channel claims to supersede.
pub fn find_upstream_counterpart(&self, config: &Config) -> Option<UpstreamChannel> {
let upstream_manifest = config.upstream_manifest().ok()?;
if let Some(same_version) =
upstream_manifest.get_channels().find(|upstream| upstream.name == self.name)
{
return Some(UpstreamChannel::new(
same_version.clone(),
UpstreamMatch::UpstreamCounterpart,
config,
));
}
let successor = upstream_manifest
.get_channels()
.find(|upstream| upstream.migrates_from.as_ref() == Some(&self.name))?;
Some(UpstreamChannel::new(
successor.clone(),
UpstreamMatch::Migrated { old_channel: self.name.clone() },
config,
))
}
// Syncs the channel to the latest changes
pub(crate) fn sync(&mut self, config: &Config) {
for comp in self.components.iter_mut() {
comp.sync(config);
}
}
}
impl fmt::Display for Channel {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match &self.alias {
Some(ChannelAlias::Stable) => write!(f, "stable ({})", self.name),
Some(ChannelAlias::Tag(tag)) => write!(f, "{}-{}", self.name, tag.as_ref()),
Some(ChannelAlias::Nightly(tag)) => {
let nightly_suffix =
tag.as_ref().map(|suffix| format!("-{}", suffix)).unwrap_or(String::from(""));
write!(f, "nightly-{}{}", self.name, nightly_suffix)
},
None => write!(f, "{}", self.name),
}
}
}