Skip to main content

PromptContentReference

Enum PromptContentReference 

Source
pub enum PromptContentReference {
    Inline(String),
    FilePath {
        path: PathBuf,
        description: String,
    },
}
Expand description

Represents content that can be either inline or referenced by path.

When content is small enough, it’s embedded directly in the prompt. When content exceeds MAX_INLINE_CONTENT_SIZE, instructions are provided to the agent to read the content from a file.

Variants§

§

Inline(String)

Content is small enough to embed inline in the prompt.

§

FilePath

Content is too large; agent should read from this absolute path.

Fields

§path: PathBuf

Absolute path to the backup file containing the content.

§description: String

Human-readable description of what the content contains.

Implementations§

Source§

impl PromptContentReference

Source

pub fn from_content( content: String, backup_path: &Path, description: &str, ) -> Self

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

If content.len() <= MAX_INLINE_CONTENT_SIZE, the content is stored inline. Otherwise, a file path reference is created.

§Arguments
  • content - The content to reference
  • backup_path - Path where the content can be read if too large
  • description - Description of the content for agent instructions
Source

pub fn inline(content: String) -> Self

Create an inline reference (for small content).

Source

pub fn file_path(path: PathBuf, description: &str) -> Self

Create a file path reference (for large content).

Source

pub fn is_inline(&self) -> bool

Returns true if this is an inline reference.

Source

pub fn render_for_template(&self) -> String

Get the content for template rendering.

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

Trait Implementations§

Source§

impl Clone for PromptContentReference

Source§

fn clone(&self) -> PromptContentReference

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 PromptContentReference

Source§

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

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

impl PartialEq for PromptContentReference

Source§

fn eq(&self, other: &PromptContentReference) -> 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 PromptContentReference

Source§

impl StructuralPartialEq for PromptContentReference

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.