Struct Tools

Source

pub struct Tools { /* private fields */ }

Expand description

Declarative selection of the built-in tools installed for an agent.

Implementations§

Source §

impl Tools

Source

pub fn builder() -> ToolsBuilder

Available on non-target_family=wasm only.

Starts a builder with all standard tools enabled.

Source

pub const fn into_builder(self) -> ToolsBuilder

Available on non-target_family=wasm only.

Resumes configuring this tool selection while preserving its built-ins, registered tools, and dynamic providers.

Source

pub const fn workspace_enabled(&self) -> bool

Available on non-target_family=wasm only.

Returns whether the standard workspace tools are enabled.

Source

pub const fn web_search_enabled(&self) -> bool

Available on non-target_family=wasm only.

Returns whether the standard web-search tool is enabled.

Source

pub const fn image_generation_enabled(&self) -> bool

Available on non-target_family=wasm only.

Returns whether the standard image-generation tool is enabled.

Source

pub fn for_session(self, session_id: &str) -> Tools

Available on non-target_family=wasm only.

Returns this tool selection bound to one agent session.

Native workspace commands receive the session ID through CODEX_THREAD_ID. This binding replaces a caller-provided value without mutating other clones of the tool selection.

Source

pub fn start_providers(&self)

Available on non-target_family=wasm only.

Starts all dynamic providers without waiting for their handshakes.

Trait Implementations§

Source §

impl Clone for Tools

Source §

fn clone(&self) -> Tools

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Debug for Tools

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Default for Tools

Source §

fn default() -> Tools

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl UnsafeUnpin for Tools

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source §

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source §

impl<T> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

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

Performs copy-assignment from self to dest. Read more

Source §

impl<T> Downcast for T
where T: Any,

Source §

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.

Source §

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.

Source §

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.

Source §

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.

Source §

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source §

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.

Source §