Struct ProtocolVersion 

pub struct ProtocolVersion {
    pub semantic: String,
    pub git_describe: Option<String>,
    pub git_hash: Option<String>,
}

Protocol version information

Contains version information for compatibility checking between rcp and rcpd. The semantic version is used for compatibility checks, while git information provides additional debugging context.

Fields

semantic: String

Semantic version from Cargo.toml (e.g., “0.22.0”)

This is the primary version used for compatibility checking.

git_describe: Option<String>

Git describe output (e.g., “v0.21.1-7-g644da27”)

Optional. Provides detailed version information including:

• Most recent tag
• Number of commits since tag
• Short commit hash
• “-dirty” suffix if working tree has uncommitted changes

git_hash: Option<String>

Full git commit hash

Optional. Useful for exact build identification and debugging.

Implementations

impl ProtocolVersion

pub fn current() -> Self

Get the current protocol version

Reads version information from environment variables set at compile time by build.rs. The semantic version is always available, while git information may be absent if the build was done without git available.

pub fn crate_version(&self) -> &str

The crate version alone — semantic with the +w<revision> build metadata stripped. This is what user-facing remedies quote (cargo install --version <this>); the wire revision is not a cargo version.

pub fn is_compatible_with(&self, other: &Self) -> bool

Check if this version is compatible with another version

Currently implements exact version matching: versions are compatible only if their semantic versions match exactly.

Examples

use common::version::ProtocolVersion;

let v1 = ProtocolVersion {
    semantic: "0.22.0".to_string(),
    git_describe: None,
    git_hash: None,
};

let v2 = ProtocolVersion {
    semantic: "0.22.0".to_string(),
    git_describe: Some("v0.21.1-7-g644da27".to_string()),
    git_hash: None,
};

assert!(v1.is_compatible_with(&v2));

pub fn cache_tag(&self) -> String

The deployed-binary cache filename component for this version: the semantic string with its + made filename-friendly (0.38.0+w1 → 0.38.0-w1).

One string for BOTH the discovery probe and the deploy target, so an incompatible same-release cached binary is never found (its filename carries the old revision) and a fresh deploy never overwrites a binary another compatibility revision still resolves to.

pub fn display(&self) -> String

Get a human-readable version string

Returns the semantic version, optionally including git describe information if available.

Examples

use common::version::ProtocolVersion;

let v = ProtocolVersion {
    semantic: "0.22.0".to_string(),
    git_describe: Some("v0.21.1-7-g644da27".to_string()),
    git_hash: None,
};

assert_eq!(v.display(), "0.22.0 (v0.21.1-7-g644da27)");

pub fn to_json(&self) -> Result<String>

Serialize to JSON string

Errors

Returns an error if JSON serialization fails.

pub fn from_json(json: &str) -> Result<Self>

Deserialize from JSON string

Errors

Returns an error if JSON deserialization fails or the format is invalid.

Trait Implementations

impl Clone for ProtocolVersion

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ProtocolVersion

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProtocolVersion

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ProtocolVersion

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for ProtocolVersion

impl PartialEq for ProtocolVersion

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for ProtocolVersion

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ProtocolVersion