Struct ToolSet 

pub struct ToolSet { /* private fields */ }

Named tools available to a call. Insertion order is preserved; names are unique.

Implementations

impl ToolSet

pub fn new() -> Self

An empty set.

pub fn insert( self, name: impl Into<ToolName>, tool: Tool, ) -> Result<Self, DuplicateToolError>

Adds a tool, consuming and returning the set.

Errors

Returns DuplicateToolError when name is already present.

pub fn try_insert( &mut self, name: impl Into<ToolName>, tool: Tool, ) -> Result<(), DuplicateToolError>

Adds a tool in place.

Errors

Returns DuplicateToolError when name is already present.

pub fn try_insert_arc( &mut self, name: impl Into<ToolName>, tool: Arc<Tool>, ) -> Result<(), DuplicateToolError>

Adds a shared tool in place.

Errors

Returns DuplicateToolError when name is already present.

pub fn replace( &mut self, name: impl Into<ToolName>, tool: Arc<Tool>, ) -> Option<Arc<Tool>>

Inserts or replaces a tool, keeping its position when replacing.

pub fn remove(&mut self, name: &str) -> Option<Arc<Tool>>

Removes a tool, preserving the order of the others.

pub fn get(&self, name: &str) -> Option<&Arc<Tool>>

Looks up a tool.

pub fn contains(&self, name: &str) -> bool

Returns true when name is present.

pub fn names(&self) -> impl Iterator<Item = &ToolName> + '_

Tool names in insertion order.

pub fn iter(&self) -> impl Iterator<Item = (&ToolName, &Arc<Tool>)> + '_

Tools in insertion order.

pub fn len(&self) -> usize

Number of tools.

pub fn is_empty(&self) -> bool

Returns true when the set has no tools.

pub fn filter_active(&self, active: &[ToolName]) -> Self

Keeps only the named tools (order of this set). Unknown names are ignored.

pub fn merge(self, other: Self) -> Result<Self, DuplicateToolError>

Merges another set into this one.

Errors

Returns DuplicateToolError for the first name present in both.

pub fn ordered(&self, order: &[ToolName]) -> Vec<(&ToolName, &Arc<Tool>)>

Tools in sending order: names listed in order first (in that order), the rest sorted alphabetically.

Trait Implementations

impl Clone for ToolSet

fn clone(&self) -> ToolSet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolSet

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

Formats the value using the given formatter.

impl Default for ToolSet

fn default() -> ToolSet

Returns the “default value” for a type.

impl<'a> IntoIterator for &'a ToolSet

type Item = (&'a ToolName, &'a Arc<Tool>)

The type of the elements being iterated over.

type IntoIter = Iter<'a, ToolName, Arc<Tool>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.