pub struct BashTool { /* private fields */ }Expand description
Bash Tool for executing shell commands
Provides secure shell command execution with:
- Dangerous command blacklist
- Warning pattern detection
- Cross-platform support
- Timeout control
- Output truncation
Requirements: 3.1
Implementations§
Source§impl BashTool
impl BashTool
Sourcepub fn with_task_manager(task_manager: Arc<TaskManager>) -> Self
pub fn with_task_manager(task_manager: Arc<TaskManager>) -> Self
Create a BashTool with custom task manager
Sourcepub fn with_sandbox(self, config: SandboxConfig) -> Self
pub fn with_sandbox(self, config: SandboxConfig) -> Self
Set sandbox configuration
Sourcepub fn with_dangerous_commands(self, commands: Vec<String>) -> Self
pub fn with_dangerous_commands(self, commands: Vec<String>) -> Self
Set custom dangerous commands
Sourcepub fn add_dangerous_commands(&mut self, commands: Vec<String>)
pub fn add_dangerous_commands(&mut self, commands: Vec<String>)
Add additional dangerous commands
Sourcepub fn with_warning_patterns(self, patterns: Vec<Regex>) -> Self
pub fn with_warning_patterns(self, patterns: Vec<Regex>) -> Self
Set custom warning patterns
Sourcepub fn task_manager(&self) -> &Arc<TaskManager>
pub fn task_manager(&self) -> &Arc<TaskManager>
Get the task manager
Source§impl BashTool
impl BashTool
Sourcepub fn check_command_safety(&self, command: &str) -> SafetyCheckResult
pub fn check_command_safety(&self, command: &str) -> SafetyCheckResult
Check if a command is safe to execute
This method checks the command against:
- Dangerous command blacklist (blocks execution)
- Warning patterns (allows with warning)
Requirements: 3.2, 3.3
Sourcepub fn is_dangerous_command(&self, command: &str) -> bool
pub fn is_dangerous_command(&self, command: &str) -> bool
Check if a command is in the dangerous commands list
Sourcepub fn has_warning(&self, command: &str) -> bool
pub fn has_warning(&self, command: &str) -> bool
Check if a command triggers any warning patterns
Source§impl BashTool
impl BashTool
Sourcepub async fn execute_foreground(
&self,
command: &str,
timeout: Duration,
context: &ToolContext,
) -> Result<ToolResult, ToolError>
pub async fn execute_foreground( &self, command: &str, timeout: Duration, context: &ToolContext, ) -> Result<ToolResult, ToolError>
Execute a command in the foreground with timeout
Supports cross-platform execution:
- Windows: Uses PowerShell or CMD
- macOS/Linux: Uses sh -c
Requirements: 3.1, 3.5
Source§impl BashTool
impl BashTool
Sourcepub async fn execute_background(
&self,
command: &str,
context: &ToolContext,
) -> Result<ToolResult, ToolError>
pub async fn execute_background( &self, command: &str, context: &ToolContext, ) -> Result<ToolResult, ToolError>
Execute a command in the background
Returns a task_id that can be used to query status and output. The actual task management is delegated to TaskManager.
Requirements: 3.4
Trait Implementations§
Source§impl Tool for BashTool
impl Tool for BashTool
Source§fn description(&self) -> &str
fn description(&self) -> &str
Returns the tool description
Source§fn input_schema(&self) -> Value
fn input_schema(&self) -> Value
Returns the JSON Schema for input parameters
Source§fn execute<'life0, 'life1, 'async_trait>(
&'life0 self,
params: Value,
context: &'life1 ToolContext,
) -> Pin<Box<dyn Future<Output = Result<ToolResult, ToolError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn execute<'life0, 'life1, 'async_trait>(
&'life0 self,
params: Value,
context: &'life1 ToolContext,
) -> Pin<Box<dyn Future<Output = Result<ToolResult, ToolError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Execute the bash command
Requirements: 3.6, 3.7
Source§fn check_permissions<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
params: &'life1 Value,
_context: &'life2 ToolContext,
) -> Pin<Box<dyn Future<Output = PermissionCheckResult> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
fn check_permissions<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
params: &'life1 Value,
_context: &'life2 ToolContext,
) -> Pin<Box<dyn Future<Output = PermissionCheckResult> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
Check permissions before execution
Performs safety check and returns appropriate permission result.
Requirements: 3.8
Source§fn options(&self) -> ToolOptions
fn options(&self) -> ToolOptions
Get tool options
Source§fn dynamic_description(&self) -> Option<String>
fn dynamic_description(&self) -> Option<String>
Source§fn get_definition(&self) -> ToolDefinition
fn get_definition(&self) -> ToolDefinition
Auto Trait Implementations§
impl Freeze for BashTool
impl !RefUnwindSafe for BashTool
impl Send for BashTool
impl Sync for BashTool
impl Unpin for BashTool
impl UnsafeUnpin for BashTool
impl !UnwindSafe for BashTool
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> FutureExt for T
impl<T> FutureExt for T
Source§fn with_context(self, otel_cx: Context) -> WithContext<Self>
fn with_context(self, otel_cx: Context) -> WithContext<Self>
Source§fn with_current_context(self) -> WithContext<Self>
fn with_current_context(self) -> WithContext<Self>
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
Source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T in a tonic::RequestSource§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self, then passes self.as_ref() into the pipe function.Source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self, then passes self.as_mut() into the pipe
function.Source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self, then passes self.deref() into the pipe function.Source§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B> of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B> of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R> view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R> view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap() only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut() only in debug builds, and is erased in release
builds.Source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref() only in debug builds, and is erased in release
builds.Source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut() only in debug builds, and is erased in release
builds.Source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref() only in debug builds, and is erased in release
builds.