Struct ToolPattern 

pub struct ToolPattern { /* private fields */ }

A tool permission pattern, ready to be emitted in a comma-joined --allowed-tools / --disallowed-tools value.

See the module docs for the accepted shapes.

Implementations

impl ToolPattern

pub fn tool(name: impl Into<String>) -> Self

A bare tool name, e.g. ToolPattern::tool("Bash") -> Bash.

No validation beyond trimming whitespace; the CLI is the source of truth for which tool names exist.

pub fn tool_with_args(name: impl Into<String>, args: impl Into<String>) -> Self

A tool with an argument glob, rendered Name(args).

assert_eq!(
    ToolPattern::tool_with_args("Bash", "git log:*").as_str(),
    "Bash(git log:*)"
);

pub fn all(name: impl Into<String>) -> Self

Shorthand for ToolPattern::tool_with_args with * as the argument pattern – “any args to this tool.”

assert_eq!(ToolPattern::all("Write").as_str(), "Write(*)");

pub fn mcp(server: impl Into<String>, tool: impl Into<String>) -> Self

An MCP pattern: mcp__{server}__{tool}. Pass "*" as the tool to match any tool from the server.

assert_eq!(
    ToolPattern::mcp("my-server", "do_thing").as_str(),
    "mcp__my-server__do_thing"
);
assert_eq!(
    ToolPattern::mcp("my-server", "*").as_str(),
    "mcp__my-server__*"
);

pub fn parse(s: impl AsRef<str>) -> Result<Self, PatternError>

Parse and validate a raw CLI-format pattern string.

Validation is shape-level only (non-empty, balanced parens, no comma or control chars). Tool names are not checked against any allowlist because the CLI’s tool inventory evolves independently.

pub fn as_str(&self) -> &str

The rendered pattern string, as it will appear in the CLI arg.

Trait Implementations

impl AsRef<str> for ToolPattern

fn as_ref(&self) -> &str

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

impl Clone for ToolPattern

fn clone(&self) -> ToolPattern

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolPattern

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

Formats the value using the given formatter.

impl Display for ToolPattern

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

Formats the value using the given formatter.

impl From<&String> for ToolPattern

fn from(s: &String) -> Self

Converts to this type from the input type.

impl From<&str> for ToolPattern

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<String> for ToolPattern

fn from(s: String) -> Self

Converts to this type from the input type.

impl Hash for ToolPattern

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 for ToolPattern

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

impl StructuralPartialEq for ToolPattern