Skill

Struct Skill 

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

A complete Agent Skill, combining frontmatter and markdown body.

This is the main type for working with skills. It can be loaded from a SKILL.md file or constructed programmatically.

§Examples

use agent_skills::Skill;

// Parse from SKILL.md content
let content = r#"---
name: my-skill
description: Does something useful.
---

Follow these steps...
"#;

let skill = Skill::parse(content).unwrap();
assert_eq!(skill.name().as_str(), "my-skill");
assert!(skill.body().contains("# Instructions"));

Implementations§

Source§

impl Skill

Source

pub fn new(frontmatter: Frontmatter, body: impl Into<String>) -> Self

Creates a new skill with frontmatter and body.

§Examples
use agent_skills::{Skill, Frontmatter, SkillName, SkillDescription};

let name = SkillName::new("my-skill").unwrap();
let desc = SkillDescription::new("Does something.").unwrap();
let frontmatter = Frontmatter::new(name, desc);

let skill = Skill::new(frontmatter, "# Instructions\n\nDo this.");
Source

pub fn parse(content: &str) -> Result<Self, ParseError>

Parses a skill from SKILL.md content.

The content must start with --- (the YAML frontmatter delimiter), followed by valid YAML, another --- delimiter, and then the markdown body.

§Errors

Returns ParseError if:

  • The content doesn’t start with ---
  • The YAML frontmatter is invalid
  • Required fields are missing or invalid
§Examples
use agent_skills::Skill;

let content = r#"---
name: my-skill
description: Does something useful.
---

Follow these steps...
"#;

let skill = Skill::parse(content).unwrap();
assert_eq!(skill.name().as_str(), "my-skill");
Source

pub const fn name(&self) -> &SkillName

Returns the skill name.

Source

pub const fn description(&self) -> &SkillDescription

Returns the skill description.

Source

pub const fn frontmatter(&self) -> &Frontmatter

Returns the frontmatter.

Source

pub fn body(&self) -> &str

Returns the markdown body (instructions).

Source

pub fn body_trimmed(&self) -> &str

Returns the body trimmed of leading/trailing whitespace.

Trait Implementations§

Source§

impl Clone for Skill

Source§

fn clone(&self) -> Skill

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 Skill

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Skill

Source§

fn eq(&self, other: &Skill) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for Skill

Source§

impl StructuralPartialEq for Skill

Auto Trait Implementations§

§

impl Freeze for Skill

§

impl RefUnwindSafe for Skill

§

impl Send for Skill

§

impl Sync for Skill

§

impl Unpin for Skill

§

impl UnwindSafe for Skill

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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.