Struct ToolTextEditor20250728 

pub struct ToolTextEditor20250728 {
    pub name: String,
    pub cache_control: Option<CacheControlEphemeral>,
    pub max_characters: Option<i32>,
}

Parameters for the Text Editor tool type, version 20250728.

This tool allows the AI to perform text editing operations via the API.

Fields

name: String

Name of the tool. This is how the tool will be called by the model and in tool_use blocks.

Always set to “str_replace_based_edit_tool”.

cache_control: Option<CacheControlEphemeral>

Create a cache control breakpoint at this content block. If provided, this instructs the API to not cache this tool or its results.

max_characters: Option<i32>

Maximum characters to display when viewing a file. If not specified, defaults to showing the full file.

Implementations

impl ToolTextEditor20250728

pub fn new() -> Self

Creates a new Text Editor tool parameter object with default settings.

pub fn with_ephemeral_cache_control(self) -> Self

Sets the cache control to ephemeral for this tool.

pub fn with_max_characters(self, max_characters: i32) -> Self

Sets the maximum characters to display when viewing a file.

Trait Implementations

impl Clone for ToolTextEditor20250728

fn clone(&self) -> ToolTextEditor20250728

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolTextEditor20250728

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

Formats the value using the given formatter.

impl Default for ToolTextEditor20250728

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ToolTextEditor20250728

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ToolTextEditor20250728

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ToolTextEditor20250728

impl<A: Agent> Tool<A> for ToolTextEditor20250728

fn name(&self) -> String

Return the name of the text editor tool.

fn callback(&self) -> Box<dyn ToolCallback<A>>

Return a callback that handles text editor operations.

This uses the same [TextEditorCallback] as other text editor tool versions, providing consistent functionality across tool versions.

fn to_param(&self) -> ToolUnionParam

Convert this tool to the union parameter type for API serialization.