Enum LeaseFile 

pub enum LeaseFile {
    Absent,
    Empty,
    Corrupt(String),
    Document(LeaseDocument),
}

What a lease file holds, read once. Every state of the file is a variant, so that a reader decides what to do about each rather than learning it from an error.

use majordomus_cli::lease::LeaseFile;
let dir = tempfile::tempdir().unwrap();
let path = dir.path().join("server.json");
assert_eq!(LeaseFile::read(&path), LeaseFile::Absent);
assert!(LeaseFile::read(&path).document().is_none(), "no document to hand back");

Variants

Absent

There is no file.

Empty

A file with nothing in it: its owner created it and has not written it yet.

Corrupt(String)

A file that is not a lease document; the reason, for the log.

Document(LeaseDocument)

A lease document.

Implementations

impl LeaseFile

pub fn read(path: &Path) -> LeaseFile

Read and type the file at path. Never fails: every state of the file is one of the variants, and what to do about each is the reader’s decision.

use majordomus_cli::lease::{LeaseFile, SCHEMA};
let dir = tempfile::tempdir().unwrap();
let path = dir.path().join("server.json");
assert_eq!(LeaseFile::read(&path), LeaseFile::Absent);
std::fs::write(&path, "").unwrap();
assert_eq!(LeaseFile::read(&path), LeaseFile::Empty);
std::fs::write(&path, "{not json").unwrap();
assert!(matches!(LeaseFile::read(&path), LeaseFile::Corrupt(r) if r.starts_with("not JSON")));
std::fs::write(&path, r#"{"schema":"other/v1"}"#).unwrap();
assert!(matches!(LeaseFile::read(&path), LeaseFile::Corrupt(r) if r.contains(SCHEMA)));
std::fs::write(&path, format!(r#"{{"schema":"{SCHEMA}","token":"x","root":"/r","url":null}}"#)).unwrap();
match LeaseFile::read(&path) {
    LeaseFile::Document(d) => { assert_eq!(d.token, "x"); assert!(d.url.is_none()); assert!(d.version.is_none()); }
    other => panic!("{other:?}"),
}

pub fn document(&self) -> Option<&LeaseDocument>

The document, when the file holds one; None for an absent, empty or corrupt file, for a reader that has no different answer for those three.

use majordomus_cli::lease::{LeaseDocument, LeaseFile, SCHEMA};
let doc = LeaseDocument {
    schema: SCHEMA.into(), pid: 7, token: "t".into(), root: "/r".into(), url: None,
    started_at: "2026-09-10T00:00:00Z".into(), executable: None, version: None,
};
assert_eq!(LeaseFile::Document(doc.clone()).document(), Some(&doc));
assert_eq!(LeaseFile::Corrupt("not JSON".into()).document(), None);

Trait Implementations

impl Clone for LeaseFile

fn clone(&self) -> LeaseFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LeaseFile

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

Formats the value using the given formatter.

impl Eq for LeaseFile

impl PartialEq for LeaseFile

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