Skip to main content

CommandsRoot

Struct CommandsRoot 

Source
pub struct CommandsRoot { /* private fields */ }
Expand description

Root directory of one set of slash command definitions (<root>/<stem>.md). Use Self::user for the user-level root at ~/.claude/commands, Self::project for a project’s <dir>/.claude/commands, or Self::at to point at an arbitrary directory for tests.

Implementations§

Source§

impl CommandsRoot

Source

pub fn user() -> Result<Self>

Resolve the user-level commands root at ~/.claude/commands. Errors if $HOME cannot be determined.

Source

pub fn project(project_dir: impl Into<PathBuf>) -> Self

Resolve a project-level commands root at <project_dir>/.claude/commands. The project_dir is the project root itself (the .claude/commands suffix is appended internally).

Source

pub fn at(path: impl Into<PathBuf>) -> Self

Use a specific path as the commands root. Useful for tests.

Source

pub fn path(&self) -> &Path

The configured root directory.

Source

pub fn list(&self) -> Result<Vec<CommandSummary>>

List every *.md command at the root, sorted by file stem.

Returns an empty vec if the root directory doesn’t exist (a project or user without custom commands). Files that fail to parse contribute a tracing warning and are skipped.

Source

pub fn get(&self, file_stem: &str) -> Result<Command>

Read one command by file stem. Errors if no such file exists or it fails to parse.

Trait Implementations§

Source§

impl Clone for CommandsRoot

Source§

fn clone(&self) -> CommandsRoot

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 CommandsRoot

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

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more