Struct ToolProfile 

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

The name of a tool profile, shared by the provider that registers it and the steps that select it.

Declare each profile once as a constant and use that constant on both sides: HttpAgentProvider::with_tool_profile and AgentConfig::tool_profile. A misspelled constant does not compile, where a misspelled string would only fail the step at run time.

It serializes as its plain name.

Examples

use ironflow_core::provider::{AgentConfig, ToolProfile};

const BUG: ToolProfile = ToolProfile::new("bug");

let config = AgentConfig::new("Find the root cause").tool_profile(BUG);
assert_eq!(config.tool_profile, Some(BUG));
assert_eq!(BUG.to_string(), "bug");

Implementations

impl ToolProfile

pub const fn new(name: &'static str) -> ToolProfile

Name a tool profile.

Panics

Panics if name is empty. In a const, that is a compile error.

Examples

use ironflow_core::provider::ToolProfile;

const SUGGESTION: ToolProfile = ToolProfile::new("suggestion");
assert_eq!(SUGGESTION.as_str(), "suggestion");

use ironflow_core::provider::ToolProfile;

let _ = ToolProfile::new("");

pub fn as_str(&self) -> &str

The profile name.

Examples

use ironflow_core::provider::ToolProfile;

assert_eq!(ToolProfile::new("bug").as_str(), "bug");

Trait Implementations

impl Clone for ToolProfile

fn clone(&self) -> ToolProfile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolProfile

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolProfile

fn deserialize<D>( deserializer: D, ) -> Result<ToolProfile, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ToolProfile

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

Formats the value using the given formatter.

impl Eq for ToolProfile

impl Hash for ToolProfile

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 ToolProfile

fn cmp(&self, other: &ToolProfile) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for ToolProfile

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ToolProfile

fn partial_cmp(&self, other: &ToolProfile) -> 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 Serialize for ToolProfile

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ToolProfile