pub struct SkillDraft { /* private fields */ }skills only.Expand description
A skill to be written to disk.
name and description are required by the specification; everything else is optional and is
omitted from the generated file when unset.
§Example
use adk_skill::SkillDraft;
let draft = SkillDraft::new("disk-triage", "Diagnose low disk space. Use when a disk alert fires.")
.with_body("1. Check the largest directories.\n2. Report growth rate.")
.with_tags(["ops"])
.with_allowed_tools(["read_file"]);
assert_eq!(draft.name(), "disk-triage");Implementations§
Source§impl SkillDraft
impl SkillDraft
Sourcepub fn new(
name: impl Into<String>,
description: impl Into<String>,
) -> SkillDraft
pub fn new( name: impl Into<String>, description: impl Into<String>, ) -> SkillDraft
Creates a draft with the two required fields.
Sourcepub fn with_body(self, body: impl Into<String>) -> SkillDraft
pub fn with_body(self, body: impl Into<String>) -> SkillDraft
Sets the instructional Markdown body.
Sourcepub fn with_version(self, version: impl Into<String>) -> SkillDraft
pub fn with_version(self, version: impl Into<String>) -> SkillDraft
Sets the version identifier.
Sourcepub fn with_license(self, license: impl Into<String>) -> SkillDraft
pub fn with_license(self, license: impl Into<String>) -> SkillDraft
Sets the license identifier.
Sourcepub fn with_compatibility(self, compatibility: impl Into<String>) -> SkillDraft
pub fn with_compatibility(self, compatibility: impl Into<String>) -> SkillDraft
Sets the environment requirements.
Sets the discovery tags.
Sourcepub fn with_allowed_tools<I, S>(self, tools: I) -> SkillDraft
pub fn with_allowed_tools<I, S>(self, tools: I) -> SkillDraft
Sets the pre-approved tool names.
Sourcepub fn with_references<I, S>(self, references: I) -> SkillDraft
pub fn with_references<I, S>(self, references: I) -> SkillDraft
Sets the supporting resource paths.
Sourcepub fn with_trigger(self, trigger: bool) -> SkillDraft
pub fn with_trigger(self, trigger: bool) -> SkillDraft
Requires explicit invocation by name rather than automatic selection.
Sourcepub fn with_hint(self, hint: impl Into<String>) -> SkillDraft
pub fn with_hint(self, hint: impl Into<String>) -> SkillDraft
Sets the guided-input hint.
Sourcepub fn with_metadata(self, metadata: HashMap<String, Value>) -> SkillDraft
pub fn with_metadata(self, metadata: HashMap<String, Value>) -> SkillDraft
Sets the extension metadata.
Useful for recording provenance — which incident a learned skill came from, when it was promoted, and what evidence supported it.
Sourcepub fn with_metadata_entry(
self,
key: impl Into<String>,
value: Value,
) -> SkillDraft
pub fn with_metadata_entry( self, key: impl Into<String>, value: Value, ) -> SkillDraft
Adds one extension metadata entry.
Sourcepub fn with_triggers<I, S>(self, triggers: I) -> SkillDraft
pub fn with_triggers<I, S>(self, triggers: I) -> SkillDraft
Sets the file glob patterns that activate this skill.
Sourcepub fn validate(&self) -> Result<(), SkillError>
pub fn validate(&self) -> Result<(), SkillError>
Checks the draft against the specification.
§Errors
Returns SkillError::Validation when the name is invalid or the description is empty.
Sourcepub fn to_markdown(&self) -> Result<String, SkillError>
pub fn to_markdown(&self) -> Result<String, SkillError>
Renders the draft as skill Markdown: YAML frontmatter, then the body.
The output is what parse_skill_markdown accepts, so a
draft written and reparsed yields equivalent content.
§Errors
Returns an error if the draft fails validate or the frontmatter cannot
be serialized.
Trait Implementations§
Source§impl Clone for SkillDraft
impl Clone for SkillDraft
Source§fn clone(&self) -> SkillDraft
fn clone(&self) -> SkillDraft
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for SkillDraft
impl Debug for SkillDraft
Source§impl Default for SkillDraft
impl Default for SkillDraft
Source§fn default() -> SkillDraft
fn default() -> SkillDraft
Auto Trait Implementations§
impl Freeze for SkillDraft
impl RefUnwindSafe for SkillDraft
impl Send for SkillDraft
impl Sync for SkillDraft
impl Unpin for SkillDraft
impl UnsafeUnpin for SkillDraft
impl UnwindSafe for SkillDraft
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self to use its Binary implementation when Debug-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self to use its Display implementation when
Debug-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self to use its LowerExp implementation when
Debug-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self to use its LowerHex implementation when
Debug-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self to use its Octal implementation when Debug-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self to use its Pointer implementation when
Debug-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self to use its UpperExp implementation when
Debug-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self to use its UpperHex implementation when
Debug-formatted.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreimpl<T> MaybeSend for Twhere
T: Send,
Source§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self, then passes self.as_ref() into the pipe function.Source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self, then passes self.as_mut() into the pipe
function.Source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self, then passes self.deref() into the pipe function.Source§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B> of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B> of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R> view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R> view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap() only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut() only in debug builds, and is erased in release
builds.Source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref() only in debug builds, and is erased in release
builds.Source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut() only in debug builds, and is erased in release
builds.Source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref() only in debug builds, and is erased in release
builds.