Struct PeerCheckout 

pub struct PeerCheckout {
    pub id: String,
    pub worktree: PathBuf,
    pub branch: Option<String>,
    pub this_checkout: bool,
}

Which checkout of the repository a peer is attached to.

A board is one process’s memory and a server serves one checkout, so a peer read from a sibling checkout’s server and a peer of this one are otherwise indistinguishable — and worse than indistinguishable, because the ids collide: p1 is the first session of every board, so a repository-wide listing without this field would hold several peers called p1 and no way to tell them apart. This is the qualification. The worktree path is the durable half of a worker’s identity: the peer id is a position on one board and is handed out again after a reconnect (p3 this morning, p1 after the bridge re-attached), while the checkout a worker is working in outlives its connection.

Absent on a peer a server reports about its own board without being asked which checkout that is — peers.announce answers about the announcing session and the answer is this server’s by construction. The repository-wide listing stamps every peer it gathers, its own included, so that no entry of that answer is unqualified.

use majordomus_cli::peers::PeerCheckout;
let c = PeerCheckout {
    id: "b8293f11".into(),
    worktree: "/repo-wt/feature/x".into(),
    branch: Some("feature/x".into()),
    this_checkout: false,
};
let v = serde_json::to_value(&c).unwrap();
assert_eq!(v["branch"], "feature/x");
assert_eq!(v["this_checkout"], false);

Fields

id: String

The checkout’s identity digest, the same value server.status reports as checkout_id. One per checkout, never a path, and stable across a restart.

worktree: PathBuf

Where the checkout is. The one thing on this board that a human can act on directly, and the one thing that survives a reconnect.

branch: Option<String>

The branch checked out there, when it could be read.

this_checkout: bool

Whether this is the checkout of the server answering the call.

Trait Implementations

impl Clone for PeerCheckout

fn clone(&self) -> PeerCheckout

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PeerCheckout

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PeerCheckout

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for PeerCheckout

impl JsonSchema for PeerCheckout

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for PeerCheckout

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for PeerCheckout

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 PeerCheckout