Struct OpSpec 

pub struct OpSpec {

    pub name: &'static str,
    pub category: Category,
    pub summary: &'static str,
    pub about: &'static str,
    pub params: Vec<ParamSpec>,
    pub inputs: Inputs,
    pub examples: Vec<Example>,
    pub presets: Vec<Preset>,
    pub auto_mix: bool,
    pub best_effort: bool,
    pub aliases: Vec<&'static str>,
    pub positional: Option<&'static str>,
    pub runner: Runner,
}

The definition of one command.

Fields

name: &'static str

Space-separated command path, e.g. "denoise profile", "midi quantize".

category: Category

summary: &'static str

One line: what it does.

about: &'static str

Longer plain-language explanation for people.

params: Vec<ParamSpec>

inputs: Inputs

examples: Vec<Example>

presets: Vec<Preset>

auto_mix: bool

The executor adds a generic --mix dry/wet when the op is a Transform that keeps the length and channel count, unless the op declares its own mix param.

best_effort: bool

Best-effort quality tier (labelled in docs and results).

aliases: Vec<&'static str>

Other names the command answers to.

positional: Option<&'static str>

When set, positional words on the command line fill this parameter instead of being input files (ferraus schema separate, ferraus models pull <name>).

runner: Runner

Implementations

impl OpSpec

pub fn new( name: &'static str, category: Category, summary: &'static str, runner: Runner, ) -> OpSpec

pub fn transform( name: &'static str, category: Category, summary: &'static str, f: TransformFn, ) -> OpSpec

pub fn custom( name: &'static str, category: Category, summary: &'static str, f: CustomFn, ) -> OpSpec

pub fn about(self, a: &'static str) -> Self

pub fn param(self, p: ParamSpec) -> Self

pub fn params(self, ps: impl IntoIterator<Item = ParamSpec>) -> Self

pub fn inputs(self, i: Inputs) -> Self

pub fn example(self, cmd: &'static str, explain: &'static str) -> Self

pub fn preset( self, name: &'static str, help: &'static str, values: &'static [(&'static str, &'static str)], ) -> Self

pub fn no_mix(self) -> Self

pub fn best_effort(self) -> Self

pub fn positional(self, name: &'static str) -> Self

Positional words fill parameter name (implies no input files).

pub fn alias(self, a: &'static str) -> Self

pub fn id(&self) -> String

Identifier used for MCP tool names and schema files: denoise profile → denoise_profile.

pub fn is_transform(&self) -> bool

pub fn find_param(&self, name: &str) -> Option<&ParamSpec>

pub fn effective_params(&self) -> Vec<ParamSpec>

All params including the implicit ones the executor adds (mix, preset).

Trait Implementations

impl Clone for OpSpec

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OpSpec

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

Formats the value using the given formatter.

impl Serialize for OpSpec

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

where __S: Serializer,

Serialize this value into the given Serde serializer.