Struct Plan 

pub struct Plan {
    pub goal: String,
    pub session_id: Option<String>,
    pub remaining_budget: Option<i64>,
    pub effective_cap: Option<u64>,
    pub paths: Vec<PlanPath>,
}

Result envelope returned by Store::plan.

Fields

goal: String

session_id: Option<String>

Some(id) when the planner was called with --intent/ session_id; None for the bare --max-cost flow.

remaining_budget: Option<i64>

Budget remaining for session_id, when one was supplied and a cap is configured. None otherwise.

effective_cap: Option<u64>

Whichever of max_cost and remaining_budget is smaller. None when neither cap applies.

paths: Vec<PlanPath>

Paths sorted cheapest-first.

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<'de> Deserialize<'de> for Plan

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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.