Struct SkillWriter 

pub struct SkillWriter { /* private fields */ }

Available on crate feature skills only.

Writes skills into a root’s .skills directory.

The destination is the directory load_skill_index already discovers, so a skill written here is picked up by the next index load.

Example

use adk_skill::{SkillDraft, SkillWriter, load_skill_index};

let root = tempfile::tempdir().unwrap();
let writer = SkillWriter::new(root.path());

writer.write(&SkillDraft::new("disk-triage", "Diagnose low disk space.")
    .with_body("Check the largest directories first."))?;

let index = load_skill_index(root.path())?;
assert!(index.find_by_name("disk-triage").is_some());

Implementations

impl SkillWriter

pub fn new(root: impl Into<PathBuf>) -> SkillWriter

Creates a writer targeting <root>/.skills.

Pass the same root given to load_skill_index.

pub fn skills_dir(&self) -> PathBuf

The directory skills are written into.

pub fn path_for(&self, name: &str) -> Result<PathBuf, SkillError>

The path a skill of this name occupies.

Errors

Returns SkillError::Validation if the name is not a valid identifier.

pub fn write(&self, draft: &SkillDraft) -> Result<PathBuf, SkillError>

Writes draft, replacing any existing skill of the same name, and returns its path.

The write goes to a temporary file in the same directory and is then renamed, so a crash mid-write cannot leave a half-written skill that fails to parse and breaks the whole index load. Missing directories are created.

Errors

Returns SkillError::Validation if the draft is invalid, or an IO error if the write fails.

pub fn remove(&self, name: &str) -> Result<bool, SkillError>

Removes the skill of this name, returning whether a file was present.

Errors

Returns SkillError::Validation if the name is invalid, or an IO error if removal fails for a reason other than the file being absent.

pub fn exists(&self, name: &str) -> Result<bool, SkillError>

Whether a skill of this name exists.

Errors

Returns SkillError::Validation if the name is invalid.

pub fn root(&self) -> &Path

The root this writer targets.

Trait Implementations

impl Clone for SkillWriter

fn clone(&self) -> SkillWriter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SkillWriter

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

Formats the value using the given formatter.