linera_version/version_info/
mod.rs

1// Copyright (c) Zefchain Labs, Inc.
2// SPDX-License-Identifier: Apache-2.0
3
4mod r#type;
5pub use r#type::*;
6
7/// The version info baked into this build of Linera.
8pub static VERSION_INFO: VersionInfo = include!(env!("LINERA_VERSION_STATIC_PATH"));
9
10use crate::serde_pretty::Pretty;
11
12impl std::fmt::Display for VersionInfo {
13    fn fmt(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
14        write!(
15            formatter,
16            "\
17            Linera protocol: v{crate_version}\n\
18            RPC API hash: {rpc_hash}\n\
19            GraphQL API hash: {graphql_hash}\n\
20            WIT API hash: {wit_hash}\n\
21            Source code: {repo}/tree/{git_commit}{git_dirty}\n\
22            ",
23            repo = env!("CARGO_PKG_REPOSITORY"),
24            crate_version = self.crate_version,
25            rpc_hash = self.rpc_hash,
26            graphql_hash = self.graphql_hash,
27            wit_hash = self.wit_hash,
28            git_commit = self.git_commit,
29            git_dirty = if self.git_dirty { " (dirty)" } else { "" }
30        )
31    }
32}
33
34impl CrateVersion {
35    /// Whether this version is known to be API-compatible with `other`.
36    /// Note that this relation _is not_ symmetric.
37    pub fn is_compatible_with(&self, other: &CrateVersion) -> bool {
38        if self.major == 0 {
39            // Cargo conventions decree that if the major version is 0, minor versions
40            // denote backwards-incompatible changes and patch versions denote
41            // backwards-compatible changes.
42            self.minor == other.minor && self.patch <= other.patch
43        } else {
44            self.major == other.major && self.minor <= other.minor
45        }
46    }
47}
48
49async_graphql::scalar!(
50    CrateVersion,
51    "CrateVersion",
52    "The version of the Linera crates used in this build"
53);
54
55async_graphql::scalar!(
56    Pretty<CrateVersion, semver::Version>,
57    "CrateVersion",
58    "The version of the Linera crates used in this build"
59);
60
61impl VersionInfo {
62    /// Print a human-readable listing of the version information at `info` level.
63    pub fn log(&self) {
64        for line in format!("{self}").lines() {
65            tracing::info!("{line}");
66        }
67    }
68
69    /// A static string corresponding to `VersionInfo::default().to_string()` preceded by
70    /// a newline. The newline is meant for `clap` as in `#[command(version =
71    /// linera_version::VersionInfo::default_clap_str())]`
72    pub fn default_clap_str() -> &'static str {
73        use std::sync::LazyLock;
74        static STRING: LazyLock<String> = LazyLock::new(|| format!("\n{}", VersionInfo::default()));
75        STRING.as_str()
76    }
77
78    /// Whether this version is known to be (remote!) API-compatible with `other`.
79    /// Note that this relation _is not_ symmetric.
80    /// It also may give false negatives.
81    pub fn is_compatible_with(&self, other: &VersionInfo) -> bool {
82        self.api_hashes() == other.api_hashes()
83            || self
84                .crate_version
85                .value
86                .is_compatible_with(&other.crate_version.value)
87    }
88}
89
90impl Default for VersionInfo {
91    fn default() -> Self {
92        VERSION_INFO.clone()
93    }
94}
linera_version/version_info/mod.rs

linera_version/version_info/
mod.rs
