Struct Instructions 

pub struct Instructions { /* private fields */ }

A FoundationModels instructions value.

Implementations

impl Instructions

pub const fn new() -> Self

Create empty instructions.

pub fn push_text(&mut self, text: impl Into<String>)

Append a text segment.

pub fn push_structured( &mut self, source: impl Into<String>, content: GeneratedContent, )

Append a structured content segment.

pub fn segments(&self) -> &[Segment]

Borrow the instruction segments.

pub fn into_segments(self) -> Vec<Segment>

Consume the instructions and return their segments.

Trait Implementations

impl Clone for Instructions

fn clone(&self) -> Instructions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Instructions

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

Formats the value using the given formatter.

impl Default for Instructions

fn default() -> Instructions

Returns the “default value” for a type.

impl From<&str> for Instructions

fn from(text: &str) -> Self

Converts to this type from the input type.

impl From<GeneratedContent> for Instructions

fn from(content: GeneratedContent) -> Self

Converts to this type from the input type.

impl From<String> for Instructions

fn from(text: String) -> Self

Converts to this type from the input type.

impl From<Vec<Segment>> for Instructions

fn from(segments: Vec<Segment>) -> Self

Converts to this type from the input type.

impl PartialEq for Instructions

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Instructions

impl ToInstructions for &Instructions

fn to_instructions(self) -> Result<Instructions, FMError>

Convert the value into instructions.

impl ToInstructions for Instructions

fn to_instructions(self) -> Result<Instructions, FMError>

Convert the value into instructions.