Struct wpexec::Args

pub(crate) struct Args {
    pub(crate) module_type: ModuleType,
    pub(crate) json_arg: Option<String>,
    pub(crate) variant_arg: Option<String>,
    pub(crate) plugins: Vec<String>,
    pub(crate) module: Option<String>,
}

Command-line arguments parsed via clap

Fields

module_type: ModuleType

json_arg: Option<String>

JSON arguments to pass to the loaded module

Lua scripts only support arrays and dictionary maps.

variant_arg: Option<String>

GLIB Variant argument to pass to the loaded module

https://docs.gtk.org/glib/gvariant-text-format.html

plugins: Vec<String>

Associated plugins to load, provided by the module

module: Option<String>

Name or full path of the module or script to load

Implementations

impl Args

pub(crate) fn plugins(&self) -> Vec<&str>

The Plugin names to load as part of initialization

For example, the ModuleType::Lua module provides a lua-scripting plugin that’s responsible for loading and running lua scripts.

pub(crate) fn module(&self) -> Option<&str>

The module or script to load

This can be a full path or often just be a name if WirePlumber knows where to find it (the rules for this are convoluted though, so I won’t get into that here)

pub(crate) fn lua_variant(&self) -> Result<Option<LuaVariant<'_>>>

A JSON-like blob of data to pass as an argument to the script to be loaded

pub(crate) fn args(&self) -> Result<Option<Variant>>

A JSON-like blob of data to pass as an argument to the script or module to be loaded

In practice this must be a dictionary or array because lua scripts can’t work with other types of data as the top-level container, but more specific types may be usable by other modules. See wireplumber::lua for a more detailed explanation.

Trait Implementations

impl Args for Args

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

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

Append to Command so it can instantiate Self.

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

Append to Command so it can update self.

impl CommandFactory for Args

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for Args

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

Formats the value using the given formatter.

impl FromArgMatches for Args

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 Parser for Args

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.