Struct RoadmapFile 

pub struct RoadmapFile {
    pub schema_version: i64,
    pub id: String,
    pub title: String,
    pub tree: Plan,
}

A roadmap as it appears on disk: id + title + the Roadmap→Phase→Plan→Task tree. deny_unknown_fields keeps the schema loud, matching plan.rs.

Fields

schema_version: i64

ROADMAP_FILE_SCHEMA_VERSION at write time; imports refuse a version newer than they understand rather than mis-reading it.

id: String

The roadmap’s store id, preserved across export/import so the repo file and every machine’s working copy name the same roadmap.

title: String

Human title, as shown by /roadmap list.

tree: Plan

The node tree. Serialized under [tree] / [[tree.subtask]].

Implementations

impl RoadmapFile

pub fn new(id: impl Into<String>, title: impl Into<String>, tree: Plan) -> Self

Wrap a store roadmap for export, stamping the current schema version.

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

Serialize to the on-repo TOML text.

Errors

Returns the toml serialization error (should not occur for a well-formed tree).

pub fn from_toml_str(s: &str) -> Result<Self>

Parse and validate on-repo TOML text. Fail-loud by design: a malformed or future-versioned file is a hard error so an import never writes a garbage tree into the store.

Errors

On TOML that does not match the schema, a schema_version newer than this build understands, an id outside the record-id alphabet (ASCII alphanumeric + -), or a blank title.

Trait Implementations

impl Clone for RoadmapFile

fn clone(&self) -> RoadmapFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RoadmapFile

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RoadmapFile

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for RoadmapFile

impl PartialEq for RoadmapFile

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for RoadmapFile

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 RoadmapFile