Struct Prompt 

pub struct Prompt { /* private fields */ }

Prompt text that has been checked for C-FFI compatibility.

Implementations

impl Prompt

pub fn new(value: impl Into<String>) -> Result<Self, Error>

Creates a prompt, rejecting text containing interior null bytes.

Use this when you want to validate user-provided prompt text before constructing a LanguageModelSession or calling respond.

Examples

use aimx::Prompt;

let prompt = Prompt::new("Summarize this note")?;
assert_eq!(prompt.as_str(), "Summarize this note");

Errors

Returns Error::NullByte if value contains an interior null byte.

pub fn as_str(&self) -> &str

Borrows the prompt as UTF-8 text.

Trait Implementations

impl AsRef<str> for Prompt

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Prompt

fn clone(&self) -> Prompt

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Prompt

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

Formats the value using the given formatter.

impl PartialEq for Prompt

fn eq(&self, other: &Prompt) -> 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 TryFrom<&str> for Prompt

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<PromptText> for Prompt

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: PromptText) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for Prompt

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Prompt

impl StructuralPartialEq for Prompt