Struct PlanRequest 

pub struct PlanRequest {
    pub target: Utf8PathBuf,
    pub intent: Intent,
    pub selector: String,
    pub fetch: bool,
    pub observe_forge: bool,
    pub flags: Flags,
    pub decisions: BTreeMap<String, String>,
}

One request to compute a plan, as the store keeps it beside the plan so an apply can compute the same plan again and compare.

Fields

target: Utf8PathBuf

The target, absolute and symlink-resolved, so a stored plan names one checkout and never whichever directory an apply runs in.

intent: Intent

What the caller asked the plan to be.

selector: String

The selector as given: embedded, latest, or an exact version.

fetch: bool

Whether a recorded release the cache does not hold is fetched.

observe_forge: bool

Whether the forge is read.

flags: Flags

The explicit answers.

decisions: BTreeMap<String, String>

The decisions selected, by id.

Implementations

impl PlanRequest

pub fn canonicalized(self) -> Result<Self, RkError>

The same request with its target resolved to an absolute, symlink-free path.

Every construction site takes this before the request reaches the planner or the store. A relative target would otherwise resolve against whichever directory an apply runs in, so a plan approved against one checkout could land in another whose content happens to match, which the fingerprint alone cannot catch.

Errors

[RkError::Usage] where the target does not exist or cannot be resolved, and [RkError::Other] where the resolved path is not valid UTF-8.

Trait Implementations

impl Clone for PlanRequest

fn clone(&self) -> PlanRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PlanRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PlanRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PlanRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.