Struct Skill 

pub struct Skill { /* private fields */ }

A skill: its frontmatter, its instructions and any further files.

Implementations

impl Skill

pub fn new( name: impl Into<String>, description: impl Into<String>, body: impl Into<String>, ) -> Result<Self, SkillError>

A skill with a name, a description and the instructions below the frontmatter.

Errors

Returns an error for a name the specification refuses or a description that is empty or too long.

pub fn with_field( self, key: impl Into<String>, value: impl Into<String>, ) -> Result<Self, SkillError>

Add a top-level frontmatter field, such as license.

Errors

Returns an error for a key that is not a plain lowercase word or that the crate writes itself.

pub fn with_metadata( self, key: impl Into<String>, value: impl Into<String>, ) -> Result<Self, SkillError>

Add an entry to the metadata map, next to the ownership record.

Errors

Returns an error for a key that is not a plain word or that belongs to the ownership record.

pub fn with_file( self, path: impl Into<PathBuf>, content: impl Into<Vec<u8>>, ) -> Result<Self, SkillError>

Add a further file, such as references/api.md.

Errors

Returns an error for a path that is absolute, contains .. or ., is empty, or names SKILL.md itself.

pub fn name(&self) -> &str

The skill’s name, which is also its directory’s name.

Trait Implementations

impl Clone for Skill

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Skill

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

Formats the value using the given formatter.

impl Eq for Skill

impl PartialEq for Skill

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Skill