Skip to main content

ToolSpec

Struct ToolSpec 

Source
pub struct ToolSpec {
    pub bin_name: &'static str,
    pub display_name: &'static str,
    pub version: &'static str,
    pub license: LicenseType,
    pub repo: RepoInfo,
    pub supports_json: bool,
    pub supports_doctor: bool,
    pub supports_update: bool,
    pub agent_surface: Option<&'static AgentSurfaceSpec>,
}
Expand description

Shared metadata for a CLI binary.

Fields§

§bin_name: &'static str

Binary name shown in version output and help text.

§display_name: &'static str

Human-readable tool name.

§version: &'static str

Binary version.

§license: LicenseType

License rendered by the shared license command.

§repo: RepoInfo

Repository metadata used by update helpers.

§supports_json: bool

Whether the tool supports JSON output in base commands.

§supports_doctor: bool

Whether the tool exposes doctor checks.

§supports_update: bool

Whether the tool exposes update support.

§agent_surface: Option<&'static AgentSurfaceSpec>

Declarative agent-mode surface for the tool.

Implementations§

Source§

impl ToolSpec

Source

pub const fn new( bin_name: &'static str, display_name: &'static str, version: &'static str, license: LicenseType, repo: RepoInfo, supports_json: bool, supports_doctor: bool, supports_update: bool, ) -> Self

Create a new ToolSpec.

Source

pub const fn workspace( bin_name: &'static str, display_name: &'static str, version: &'static str, license: LicenseType, supports_json: bool, supports_doctor: bool, supports_update: bool, ) -> Self

Create a new ToolSpec using WORKSPACE_REPO.

Source

pub const fn with_agent_surface( self, agent_surface: &'static AgentSurfaceSpec, ) -> Self

Attach an agent surface to the tool specification.

Trait Implementations§

Source§

impl Clone for ToolSpec

Source§

fn clone(&self) -> ToolSpec

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ToolSpec

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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<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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.