Struct soapysdr::ArgInfo

pub struct ArgInfo {
    pub key: String,
    pub value: String,
    pub name: Option<String>,
    pub description: Option<String>,
    pub units: Option<String>,
    pub data_type: ArgType,
    pub options: Vec<(String, Option<String>)>,
}

Metadata about supported arguments.

Fields

key: String

The key used to identify the argument

value: String

The default value of the argument when not specified

name: Option<String>

The displayable name of the argument

description: Option<String>

A brief description about the argument

units: Option<String>

The units of the argument: dB, Hz, etc

data_type: ArgType

The data type of the argument

options: Vec<(String, Option<String>)>

A discrete list of possible values.

When specified, the argument should be restricted to this options set.

Trait Implementations

impl Debug for ArgInfo

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

Formats the value using the given formatter.