Skip to main content

ExecSpec

Struct ExecSpec 

Source
pub struct ExecSpec {
Show 13 fields pub argv: Vec<String>, pub passthrough: bool, pub url: Option<String>, pub file: Option<String>, pub kotlin: Option<String>, pub python: Option<String>, pub node: Option<String>, pub bash: Option<String>, pub sh: Option<String>, pub zsh: Option<String>, pub text: Option<String>, pub sha256: Option<String>, pub ttl: Option<u64>,
}

Fields§

§argv: Vec<String>

Program argv. For remote url / local file leaves this is an optional interpreter prefix (e.g. ["python3"]); the script path is appended automatically. For kotlin: leaves this is the argument list passed to main.

§passthrough: bool

Append extra CLI arguments after those from argv / the script path.

§url: Option<String>

HTTPS URL of a remote script to download, verify, and run.

§file: Option<String>

Local script path relative to the jan use root (optional sha256 pin).

§kotlin: Option<String>

Kotlin source relative to the jan use root (.kt / .kts), or an inline program (multiline YAML string). Paths are a single line ending in .kt/.kts; anything else is treated as inlined source and compile-once as .kt. argv is passed to main.

§python: Option<String>

Python source relative to the jan use root (.py), or an inline program. Runs with the packages.uv venv interpreter when present. argv is forwarded after the script / -c body (sys.argv).

§node: Option<String>

JavaScript source relative to the jan use root (.js / .mjs / .cjs), or an inline program. Runs with node and packages.pnpm NODE_PATH when present. argv is forwarded on process.argv.

§bash: Option<String>

Bash source relative to the jan use root (.sh / .bash), or an inline program (bash -lc). argv is $1… ($0 is the command name).

§sh: Option<String>

POSIX sh source (.sh) or inline (sh -c). argv is $1….

§zsh: Option<String>

Zsh source (.zsh / .sh) or inline (zsh -c). argv is $1….

§text: Option<String>

Literal text to print with no subprocess (text: or alias cat:).

§sha256: Option<String>

SHA256 of the script: required with url, optional with file.

§ttl: Option<u64>

Optional TTL override (seconds) for the remote script cache.

Implementations§

Source§

impl ExecSpec

Source

pub fn is_remote(&self) -> bool

Source

pub fn is_local_file(&self) -> bool

Source

pub fn is_kotlin(&self) -> bool

Source

pub fn is_python(&self) -> bool

Source

pub fn is_node(&self) -> bool

Source

pub fn is_bash(&self) -> bool

Source

pub fn is_sh(&self) -> bool

Source

pub fn is_zsh(&self) -> bool

Source

pub fn is_text(&self) -> bool

Source

pub fn literal_text(&self) -> Option<&str>

Body for exec.text / exec.cat, trimmed of surrounding whitespace.

Source

pub fn is_language_source(&self) -> bool

True when a language exec.* field is set.

Source

pub fn kotlin_value_is_path(raw: &str) -> bool

True when raw is a single-line .kt / .kts path (not inline source).

Source

pub fn python_value_is_path(raw: &str) -> bool

Source

pub fn node_value_is_path(raw: &str) -> bool

Source

pub fn bash_value_is_path(raw: &str) -> bool

Source

pub fn sh_value_is_path(raw: &str) -> bool

Source

pub fn zsh_value_is_path(raw: &str) -> bool

Source

pub fn kotlin_is_path(&self) -> bool

True when exec.kotlin names a tree-relative .kt / .kts file.

Source

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

Trait Implementations§

Source§

impl Clone for ExecSpec

Source§

fn clone(&self) -> ExecSpec

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 ExecSpec

Source§

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

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

impl Default for ExecSpec

Source§

fn default() -> ExecSpec

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

impl<'de> Deserialize<'de> for ExecSpec

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

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