Enum CommandStream 

pub enum CommandStream {
    Inline {
        text: String,
    },
    Stored {
        file: StoredFile,
        preview: String,
        truncated: bool,
    },
    Image {
        media_type: String,
        file: StoredFile,
    },
}

One output stream of a command.

Variants

Inline

Output small enough to keep in the result.

Fields

text: String

The output text.

Stored

Output written to a file.

Fields

file: StoredFile

Where the full output is stored.

preview: String

What the model is shown (head/tail or folded view); empty when the output has no text view.

truncated: bool

Whether preview is partial.

Image

Image output, always written to a file.

Fields

media_type: String

MIME type of the image.

file: StoredFile

Where the image is stored.

Implementations

impl CommandStream

pub const fn is_empty(&self) -> bool

Returns true when the stream holds no output.

pub fn render_for_model(&self) -> String

Renders the stream as the newline-terminated block the model reads; an empty stream renders as the empty string.

Panics

Panics if the template fails to render, which formatting in-memory strings cannot do.

Trait Implementations

impl Clone for CommandStream

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommandStream

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CommandStream

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for CommandStream

impl PartialEq for CommandStream

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for CommandStream

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CommandStream