Struct LeaseDocument 

pub struct LeaseDocument {
    pub schema: String,
    pub pid: u32,
    pub token: String,
    pub root: PathBuf,
    pub url: Option<String>,
    pub started_at: String,
    pub executable: Option<ExecutableIdentity>,
    pub version: Option<String>,
}

The lease file, typed: what the process serving a checkout wrote down about itself. Every reader of the file — the election, a command asking which server is running, the environment snapshot, the server’s own status — reads it through LeaseFile::read, so that a field added here is added once and a file that is not a lease is refused in one place. A key this version does not know is ignored, so a lease written by a newer executable still reads; a key it needs that an older lease lacks takes its default.

use majordomus_cli::lease::{LeaseDocument, SCHEMA};
// a lease an older server wrote: no pid, no version, a key this version has never heard of
let older = format!(r#"{{"schema":"{SCHEMA}","token":"t","root":"/r","url":"http://127.0.0.1:1","later":1}}"#);
let doc: LeaseDocument = serde_json::from_str(&older).unwrap();
assert_eq!(doc.pid, 0);
assert!(doc.version.is_none(), "older than any executable that reads this");
assert_eq!(doc.url.as_deref(), Some("http://127.0.0.1:1"));
// and what this version writes reads back as itself
let text = serde_json::to_string(&doc).unwrap();
assert_eq!(serde_json::from_str::<LeaseDocument>(&text).unwrap(), doc);

Fields

schema: String

SCHEMA.

pid: u32

The process id of the server. A live pid is not a live server: only an answering probe says that. What a live pid does decide is patience — a probe that goes unanswered by a live owner is asked again within BUSY_GRACE before the lease counts as stale (the election’s busy wait, probe_patiently); a dead or zero pid gets no patience at all.

token: String

What makes the file this process’s: only the process holding this token removes it.

root: PathBuf

The checkout root the server serves.

url: Option<String>

The address, once bound; null while the owner is still binding.

started_at: String

When the server took the lease, RFC 3339.

executable: Option<ExecutableIdentity>

The executable the server was started from, when it could be located.

version: Option<String>

The executable’s version. Absent in a lease written before this field existed, which is itself a fact: that server is older than any executable that reads this.

Trait Implementations

impl Clone for LeaseDocument

fn clone(&self) -> LeaseDocument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LeaseDocument

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LeaseDocument

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for LeaseDocument

impl JsonSchema for LeaseDocument

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 LeaseDocument

fn eq(&self, other: &LeaseDocument) -> 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 LeaseDocument

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 LeaseDocument