Skip to main content

TurnPrompt

Struct TurnPrompt 

Source
pub struct TurnPrompt {
    pub attachments: Vec<TurnPromptAttachment>,
    pub text: String,
    pub text_source: TurnPromptTextSource,
}
Expand description

Structured prompt payload for one agent turn.

Fields§

§attachments: Vec<TurnPromptAttachment>

Ordered local image attachments referenced by text.

§text: String

Prompt text payload, including inline placeholders when present.

§text_source: TurnPromptTextSource

Source classification that controls prompt-only text rewrites.

Implementations§

Source§

impl TurnPrompt

Source

pub fn from_text(text: String) -> Self

Creates a text-only prompt payload.

Source

pub fn from_agent_data(text: String) -> Self

Creates a generated-data prompt payload that is sent to the agent without user prompt @path lookup rewriting.

Source

pub fn is_empty(&self) -> bool

Returns whether the payload contains no text and no attachments.

Source

pub fn has_attachments(&self) -> bool

Returns whether the payload contains one or more image attachments.

Source

pub fn local_image_paths(&self) -> impl Iterator<Item = &PathBuf>

Returns the local image paths referenced by this prompt payload.

Source

pub fn contains(&self, needle: &str) -> bool

Returns whether the prompt text contains needle.

Source

pub fn ends_with(&self, suffix: &str) -> bool

Returns whether the prompt text ends with suffix.

Source

pub fn agent_text(&self) -> String

Returns the prompt text as it should be sent to an agent runtime.

User-authored @path lookups are rewritten to quoted path tokens for transport. Generated agent data is returned unchanged so source content such as Python decorators keeps its leading @.

Source

pub fn content_parts(&self) -> Vec<TurnPromptContentPart<'_>>

Returns prompt text spans and image attachments in transport order.

Attachments are ordered by their placeholder position in text. Any attachment whose placeholder no longer exists in the text is appended after the trailing text so transports can still serialize the image instead of dropping it silently.

Source

pub fn transcript_text(&self) -> String

Returns the prompt text as it should be written into persisted transcripts.

Inline [Image #n] markers are preserved verbatim. If attachment metadata somehow survives without its placeholder still present in the text, the missing placeholders are appended in attachment order so the transcript does not silently become text-only.

Trait Implementations§

Source§

impl Clone for TurnPrompt

Source§

fn clone(&self) -> TurnPrompt

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TurnPrompt

Source§

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

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

impl<'de> Deserialize<'de> for TurnPrompt

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for TurnPrompt

Source§

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

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

impl Eq for TurnPrompt

Source§

impl From<&TurnPrompt> for TurnPrompt

Source§

fn from(prompt: &TurnPrompt) -> Self

Converts to this type from the input type.
Source§

impl From<&str> for TurnPrompt

Source§

fn from(text: &str) -> Self

Converts to this type from the input type.
Source§

impl From<String> for TurnPrompt

Source§

fn from(text: String) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for TurnPrompt

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl PartialEq<&str> for TurnPrompt

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl PartialEq<TurnPrompt> for &str

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for TurnPrompt

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for TurnPrompt

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<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> 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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.