Struct ToolName 

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

Strongly-typed tool name label.

ToolName identifies a tool by its canonical name (e.g., "shell", "web_scrape"). It is produced by the LLM in JSON tool-use responses and matched against the registered tool registry at dispatch time.

Label semantics (not a validated reference)

ToolName is an unvalidated label from untrusted input (LLM JSON). It does not guarantee that a tool with this name is registered. Validation happens downstream at tool dispatch, not at construction.

Inner type: Arc<str>

The inner type is Arc<str>, not String. Tool names are cloned into multiple contexts (event channels, tracing spans, tool output structs) during a single tool execution. Arc<str> makes all clones O(1) vs O(n) for String. Use .clone() to duplicate a ToolName — it is cheap.

No Deref<Target=str>

ToolName does not implement Deref<Target=str>. This prevents the .to_owned() footgun where muscle memory returns String instead of ToolName. Use .as_str() for explicit string conversion and .clone() to duplicate the ToolName.

Examples

use zeph_common::ToolName;

let name = ToolName::new("shell");
assert_eq!(name.as_str(), "shell");
assert_eq!(name, "shell");

// Clone is O(1) — Arc reference count increment only.
let name2 = name.clone();
assert_eq!(name, name2);

Implementations

impl ToolName

pub fn new(s: impl Into<Arc<str>>) -> Self

Construct a ToolName from any value convertible to Arc<str>.

This is the primary constructor. The name is accepted without validation — it is a label from the LLM wire or tool registry, not a proof of registration.

Examples

use zeph_common::ToolName;

let name = ToolName::new("shell");
assert_eq!(name.as_str(), "shell");

pub fn as_str(&self) -> &str

Return the inner string slice.

Prefer this over Deref (which is intentionally not implemented) when an &str reference is needed.

Examples

use zeph_common::ToolName;

let name = ToolName::new("web_scrape");
assert_eq!(name.as_str(), "web_scrape");

Trait Implementations

impl AsRef<str> for ToolName

fn as_ref(&self) -> &str

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

impl Borrow<str> for ToolName

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for ToolName

fn clone(&self) -> ToolName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolName

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

Formats the value using the given formatter.

impl Default for ToolName

fn default() -> Self

Returns an empty ToolName.

This implementation exists solely for #[serde(default)] on optional fields. Do not construct a ToolName with an empty string in application code.

impl<'de> Deserialize<'de> for ToolName

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ToolName

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

Formats the value using the given formatter.

impl From<&str> for ToolName

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<String> for ToolName

fn from(s: String) -> Self

Converts to this type from the input type.

impl FromStr for ToolName

type Err = Infallible

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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

impl Hash for ToolName

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

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 PartialEq<&str> for ToolName

fn eq(&self, other: &&str) -> 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 PartialEq<String> for ToolName

fn eq(&self, other: &String) -> 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 PartialEq<ToolName> for String

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

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

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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ToolName

impl StructuralPartialEq for ToolName