Struct Frontmatter 

pub struct Frontmatter { /* private fields */ }

The YAML frontmatter of a SKILL.md file.

Contains both required fields (name, description) and optional fields (license, compatibility, metadata, allowed-tools).

Examples

use agent_skills::{Frontmatter, SkillName, SkillDescription};

let name = SkillName::new("my-skill").unwrap();
let description = SkillDescription::new("Does something useful.").unwrap();

let frontmatter = Frontmatter::new(name, description);
assert_eq!(frontmatter.name().as_str(), "my-skill");

Implementations

impl Frontmatter

pub const fn new(name: SkillName, description: SkillDescription) -> Self

Creates a new frontmatter with required fields only.

Use the builder for setting optional fields.

pub const fn builder( name: SkillName, description: SkillDescription, ) -> FrontmatterBuilder

Returns a builder for constructing frontmatter with optional fields.

Examples

use agent_skills::{Frontmatter, SkillName, SkillDescription, Metadata};

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

let frontmatter = Frontmatter::builder(name, desc)
    .license("MIT")
    .metadata(Metadata::from_pairs([("author", "test")]))
    .build();

assert_eq!(frontmatter.license(), Some("MIT"));

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

Returns the skill name.

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

Returns the skill description.

pub fn license(&self) -> Option<&str>

Returns the license, if specified.

pub const fn compatibility(&self) -> Option<&Compatibility>

Returns the compatibility string, if specified.

pub const fn metadata(&self) -> Option<&Metadata>

Returns the metadata, if specified.

pub const fn allowed_tools(&self) -> Option<&AllowedTools>

Returns the allowed tools, if specified.

Trait Implementations

impl Clone for Frontmatter

fn clone(&self) -> Frontmatter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Frontmatter

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Frontmatter

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Frontmatter

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Frontmatter

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Frontmatter

impl StructuralPartialEq for Frontmatter