Skip to main content

LoopSkill

Struct LoopSkill 

Source
pub struct LoopSkill {
    pub name: String,
    pub description: Option<String>,
    pub version: Option<String>,
    pub scope: SkillScope,
    pub dir: PathBuf,
    pub manifest: PathBuf,
    pub model_invocable: bool,
    pub allowed_tools: Vec<String>,
    pub argument_names: Vec<String>,
    pub argument_hint: Option<String>,
}
Expand description

One SKILL.md package the supercode loop itself will load.

Fields§

§name: String

The name the loop invokes it by — frontmatter name (else the directory name), qualified plugin:skill / dir:skill where the source harness qualifies it.

§description: Option<String>

Frontmatter description, one line. The INDEX line’s whole payload; a skill without one is still invocable, just undescribed.

§version: Option<String>

Frontmatter version.

§scope: SkillScope

Precedence class of the root it came from.

§dir: PathBuf

The skill’s own directory.

§manifest: PathBuf

<dir>/SKILL.md — where the BODY lives, read only on invocation.

§model_invocable: bool

Whether the model may see it in the prompt index at all. false for enabled: false / disable-model-invocation: true frontmatter: the skill stays user-invocable by name, it is simply not advertised (cc§7 “Invocation control”, pi§2).

§allowed_tools: Vec<String>

BP-5 (cc§7 “Invocation control”: “pre-approved tools while active”): the package’s own allowed-tools frontmatter, verbatim. Its only consumer is ShellInjection::expand, where it pre-approves this body’s OWN !`cmd` commands and nothing else — it never widens what the model’s tool calls are allowed to do.

§argument_names: Vec<String>

BP-5 (cc§7 “Skill frontmatter”: arguments (named positional)): the package’s ARGUMENT SCHEMA — the names its body substitutes as $name, in positional order. Empty when the body only uses $ARGUMENTS/$1..$9.

§argument_hint: Option<String>

BP-5 (cc§7 argument-hint): the one-line usage hint shown beside this package in the prompt index, so a model calling it by name knows what the trailing text should be.

Implementations§

Source§

impl LoopSkill

Source

pub fn index_line(&self) -> String

The prompt-index line: name and description only — never the body.

Source

pub fn body(&self, arguments: &str) -> Result<String, Error>

Read this skill’s BODY (everything after the frontmatter fence), substituting $ARGUMENTS / $1..$9 with the invocation’s trailing text. This is the ONLY function that spends a body’s tokens; nothing on the discovery path reads past the frontmatter.

Source

pub fn body_with_shell( &self, arguments: &str, shell: &ShellInjection, ) -> Result<String, Error>

BP-5: Self::body, then the !`cmd` expansion shell authorizes (cc§7 “Dynamic context injection”). This is the door every invocation surface uses — the skill tool, /name, /skill:name and $slug — so one body cannot mean two things depending on which door loaded it. With shell injection off (the default) this is exactly Self::body.

Trait Implementations§

Source§

impl Clone for LoopSkill

Source§

fn clone(&self) -> LoopSkill

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 LoopSkill

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for LoopSkill

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<LoopSkill, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for LoopSkill

Source§

impl PartialEq for LoopSkill

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for LoopSkill

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for LoopSkill

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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, !>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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