Struct SynthArg 

pub struct SynthArg {
    pub synth: Option<Synth>,
}

The shared --synth option. A command flattens it when it needs a target synth.

Fields

synth: Option<Synth>

The target synth [default: the extension of the preset file, else vital]

Implementations

impl SynthArg

pub fn resolve(&self, hint: Option<&Path>) -> Result<Synth, SynthError>

Resolves the target synth from the flag and an optional preset path on the command line.

1. The flag and no hint: the flag.
2. The flag and a hint with a known extension: both must agree, unless the extension has no adapter (see SynthError::FileNotReady).
3. A hint with a known extension and no flag: the extension.
4. Neither: Vital.

The result must also be in Synth::READY.

Errors

SynthError::FileNotReady when the extension names a synth without an adapter, with or without the flag, SynthError::Mismatch when the flag and an extension with an adapter disagree, and SynthError::NotBuilt for a synth without an adapter.

Trait Implementations

impl Args for SynthArg

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::ArgGroup::id] for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut]

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

impl Clone for SynthArg

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 SynthArg

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

Formats the value using the given formatter.

impl Default for SynthArg

fn default() -> Self

Returns the “default value” for a type.

impl Eq for SynthArg

impl FromArgMatches for SynthArg

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl PartialEq for SynthArg

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SynthArg