Skip to main content

PlanContentReference

Enum PlanContentReference 

Source
pub enum PlanContentReference {
    Inline(String),
    ReadFromFile {
        primary_path: PathBuf,
        fallback_path: Option<PathBuf>,
        description: String,
    },
}
Expand description

Specialized reference for PLAN content.

When PLAN is too large, instructs the agent to read from PLAN.md with optional fallback to the XML plan file.

Variants§

§

Inline(String)

PLAN is small enough to embed inline.

§

ReadFromFile

PLAN is too large; agent should read from file.

Fields

§primary_path: PathBuf

Primary path to the plan file (usually .agent/PLAN.md).

§fallback_path: Option<PathBuf>

Optional fallback path if primary is missing (usually .agent/tmp/plan.xml).

§description: String

Description of why file reading is needed.

Implementations§

Source§

impl PlanContentReference

Source

pub fn from_plan( plan_content: String, plan_path: &Path, xml_fallback_path: Option<&Path>, ) -> Self

Create a plan reference, choosing inline vs file path based on size.

If plan_content.len() <= MAX_INLINE_CONTENT_SIZE, the plan is stored inline. Otherwise, instructions to read from file are provided.

§Arguments
  • plan_content - The plan content
  • plan_path - Path to the primary plan file
  • xml_fallback_path - Optional path to XML fallback
Source

pub fn render_for_template(&self) -> String

Get the content for template rendering.

For inline: returns the plan content directly. For file path: returns instructions to read from the file.

Source

pub fn is_inline(&self) -> bool

Returns true if this is an inline reference.

Trait Implementations§

Source§

impl Clone for PlanContentReference

Source§

fn clone(&self) -> PlanContentReference

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PlanContentReference

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for PlanContentReference

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for PlanContentReference

Source§

impl StructuralPartialEq for PlanContentReference

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.