Skip to main content

SkillFile

Struct SkillFile 

Source
pub struct SkillFile {
    pub frontmatter: SkillFrontmatter,
    pub content: String,
    pub path: PathBuf,
    pub directory: PathBuf,
    pub supporting_files: Vec<SupportingFile>,
}
Expand description

Parsed skill file with frontmatter and content.

Fields§

§frontmatter: SkillFrontmatter

Parsed YAML frontmatter.

§content: String

Markdown content (instructions).

§path: PathBuf

Path to the SKILL.md file.

§directory: PathBuf

Directory containing the skill.

§supporting_files: Vec<SupportingFile>

Supporting files discovered in the directory.

Implementations§

Source§

impl SkillFile

Source

pub fn parse<P: AsRef<Path>>(path: P) -> Result<Self>

Parse a SKILL.md file from the given path.

Source

pub fn parse_content(content: &str, path: &Path) -> Result<Self>

Parse SKILL.md content with path context.

Source

pub fn parse_content_only(content: &str) -> Result<(SkillFrontmatter, String)>

Parse SKILL.md content without path context (for testing).

Source

pub fn effective_name(&self) -> String

Get effective name (from frontmatter or directory name).

Source

pub fn effective_description(&self) -> String

Get effective description (from frontmatter or first paragraph).

Source

pub fn is_tool_allowed(&self, tool_name: &str) -> bool

Check if a tool is allowed for this skill.

Supports wildcard patterns with * which matches any characters. Examples:

  • Bash matches exactly Bash
  • Bash* matches Bash, Bash(python:test.py), etc.
  • Bash(python:*) matches Bash(python:foo), Bash(python:bar), etc.

Trait Implementations§

Source§

impl Clone for SkillFile

Source§

fn clone(&self) -> SkillFile

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 SkillFile

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.