Skip to main content

Planning

Struct Planning 

Source
pub struct Planning {
    pub prefix: &'static str,
    pub core: &'static [&'static str],
    pub refused: fn(&str) -> Option<String>,
    pub creates: &'static [&'static str],
    pub current_env: Option<&'static str>,
    pub toward_tasks: fn(bool) -> &'static [&'static str],
    pub revises: Option<&'static str>,
    pub checks: Option<&'static str>,
    pub explores: Option<&'static str>,
    pub explore_paths: fn(&str) -> bool,
    pub explore_commands: &'static [&'static [&'static str]],
}
Expand description

Hosted planning skills.

Fields§

§prefix: &'static str

The prefix installed skills carry (plan runs <prefix>plan).

§core: &'static [&'static str]

Skills whose before_<name> / after_<name> hooks run.

§refused: fn(&str) -> Option<String>

Why a skill is not hosted, and what to use instead.

§creates: &'static [&'static str]

Core skills that create a new unit (Spec Kit: specify): they get no current-unit variable, and the unit they create becomes current.

§current_env: Option<&'static str>

The variable the format’s own scripts read the current unit from (Spec Kit: SPECIFY_FEATURE_DIRECTORY), passed to planning commands.

§toward_tasks: fn(bool) -> &'static [&'static str]

The skills that lead from what exists to a task list, given whether a plan exists (Spec Kit: plan, tasks).

§revises: Option<&'static str>

The skill that revises a written spec from a person’s comments (Spec Kit: clarify), if the format has one.

§checks: Option<&'static str>

The skill that checks the planning files for consistency (Spec Kit: analyze), if the format has one.

§explores: Option<&'static str>

The skill that explores an idea before a spec (OpenSpec: explore), if the format has one; spec explore hosts it read-only, else speccoder’s own fallback.

§explore_paths: fn(&str) -> bool

What that skill may write: the format’s own exploration artifacts.

§explore_commands: &'static [&'static [&'static str]]

The read-only commands it may run (argv prefixes).

Implementations§

Source§

impl Planning

Source

pub fn role_of(&self, short: &str) -> SkillRole

The part the skill short (without the prefix) plays: it creates a unit, leads toward the task list, revises a spec, checks the planning, or something else — in that order of precedence.

Trait Implementations§

Source§

impl Debug for Planning

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts 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 more
Source§

impl<T> IntoMaybeUndefined<T> for T

Source§

fn into_maybe_undefined(self) -> MaybeUndefined<T>

Converts this value into a three-state builder argument.
Source§

impl<T> IntoOption<T> for T

Source§

fn into_option(self) -> Option<T>

Converts this value into an optional builder argument.
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
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, 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