Skip to main content

SkillWriter

Struct SkillWriter 

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

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§

Source§

impl SkillWriter

Source

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

Creates a writer targeting <root>/.skills.

Pass the same root given to load_skill_index.

Source

pub fn skills_dir(&self) -> PathBuf

The directory skills are written into.

Source

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

The path a skill of this name occupies.

§Errors

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

Source

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

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.

Source

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

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.

Source

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

Whether a skill of this name exists.

§Errors

Returns SkillError::Validation if the name is invalid.

Source

pub fn root(&self) -> &Path

The root this writer targets.

Trait Implementations§

Source§

impl Clone for SkillWriter

Source§

fn clone(&self) -> SkillWriter

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SkillWriter

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Same for T

Source§

type Output = T

Should always be Self
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 = !

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more