Struct Plan 

pub struct Plan {
    pub action: &'static str,
    pub changes: Vec<String>,
    pub content: String,
}

Resolved landing input, including every key a preview would write.

Fields

action: &'static str

Added or updated configuration.

changes: Vec<String>

Keys whose configured answers differ from the record.

content: String

The exact authored TOML the apply writes.

Implementations

impl Plan

pub fn new( target: &Path, params: &Params, existing: Option<&Config>, record: Option<&Manifest>, ) -> Result<Self, RkError>

Resolve the output without writing it; existing comments survive.

Errors

Propagates unreadable or invalid configuration.

pub fn compose( text: Option<&str>, params: &Params, existing: Option<&Config>, record: Option<&Manifest>, ) -> Result<Self, RkError>

Resolve the output from the existing text already read, so a planner that owns no filesystem can compose it from its observation; existing comments survive.

Errors

Propagates invalid configuration.

pub fn apply(&self, target: &Path) -> Result<(), RkError>

Write the prepared configuration before the landing record.

Errors

Propagates an atomic write failure.

Trait Implementations

impl Clone for Plan

fn clone(&self) -> Plan

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Plan

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

Formats the value using the given formatter.

impl Serialize for Plan

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

where __S: Serializer,

Serialize this value into the given Serde serializer.