Skip to main content

CommandNode

Struct CommandNode 

Source
pub struct CommandNode {
    pub os: Vec<String>,
    pub about: String,
    pub path: Option<String>,
    pub dependencies: Vec<String>,
    pub requires: Vec<String>,
    pub env: EnvSpec,
    pub inputs: BTreeMap<String, InputDef>,
    pub cron: Vec<String>,
    pub packages: PackagesSpec,
    pub commands: BTreeMap<String, CommandNode>,
    pub exec: Option<ExecSpec>,
    pub source: Option<IncludeLink>,
}

Fields§

§os: Vec<String>

If non-empty, this command and its subtree are only offered on these platforms (linux, macos, windows, …). darwin is accepted as an alias for macos.

§about: String§path: Option<String>

Directory prepended to PATH when this script (or a descendant leaf) runs.

§dependencies: Vec<String>

Other script names whose path directories are prepended before this one runs.

§requires: Vec<String>

External binaries that must be on PATH (e.g. fzf, jq) before the leaf runs.

§env: EnvSpec

Public assignments and/or private names required from the host environment.

§inputs: BTreeMap<String, InputDef>

Named CLI inputs (--name value) available as ${{ inputs.name }} in env/argv.

§cron: Vec<String>

Optional crontab schedule(s). When set, jan cron runs this script’s run leaf whenever the local time matches any expression.

§packages: PackagesSpec

Package-manager dependencies (uv now; pnpm reserved).

§commands: BTreeMap<String, CommandNode>§exec: Option<ExecSpec>§source: Option<IncludeLink>

Include link this node was loaded from, if any (filled by the loader).

Implementations§

Source§

impl CommandNode

Source

pub fn is_leaf_exec(&self) -> bool

Source

pub fn validate(&self, path: &str) -> Result<()>

Trait Implementations§

Source§

impl Clone for CommandNode

Source§

fn clone(&self) -> CommandNode

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 CommandNode

Source§

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

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

impl Default for CommandNode

Source§

fn default() -> CommandNode

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for CommandNode

Source§

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

Deserialize this value from the given Serde deserializer. 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> 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> 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 = Infallible

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