Struct PromptName 

pub struct PromptName(/* private fields */);

Implementations

impl PromptName

pub fn new(value: impl AsRef<str>) -> Result<PromptName, AiPromptError>

Examples found in repository

examples/basic_usage.rs (line 4)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let prompt = PromptName::new("support-triage")?;
    let model = AiModelName::new("reasoning-chat")?;
    let tool = ToolName::new("ticket-search")?;

    assert_eq!(prompt.as_str(), "support-triage");
    assert_eq!(model.as_str(), "reasoning-chat");
    assert_eq!(tool.as_str(), "ticket-search");
    assert_eq!(AiMessageRole::Assistant.as_str(), "assistant");
    Ok(())
}

pub fn as_str(&self) -> &str

Examples found in repository

examples/basic_usage.rs (line 8)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let prompt = PromptName::new("support-triage")?;
    let model = AiModelName::new("reasoning-chat")?;
    let tool = ToolName::new("ticket-search")?;

    assert_eq!(prompt.as_str(), "support-triage");
    assert_eq!(model.as_str(), "reasoning-chat");
    assert_eq!(tool.as_str(), "ticket-search");
    assert_eq!(AiMessageRole::Assistant.as_str(), "assistant");
    Ok(())
}

pub fn value(&self) -> &str

pub fn into_string(self) -> String

Trait Implementations

impl AsRef<str> for PromptName

fn as_ref(&self) -> &str

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

impl Clone for PromptName

fn clone(&self) -> PromptName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PromptName

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

Formats the value using the given formatter.

impl Display for PromptName

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

Formats the value using the given formatter.

impl FromStr for PromptName

type Err = AiPromptError

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<PromptName, <PromptName as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for PromptName

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for PromptName

fn cmp(&self, other: &PromptName) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for PromptName

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

fn partial_cmp(&self, other: &PromptName) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<&str> for PromptName

type Error = AiPromptError

The type returned in the event of a conversion error.

fn try_from( value: &str, ) -> Result<PromptName, <PromptName as TryFrom<&str>>::Error>

Performs the conversion.

impl Eq for PromptName

impl StructuralPartialEq for PromptName