Struct soapysdr::Args

pub struct Args(/* private fields */);

A list of key=value pairs.

Implementations

impl Args

pub fn new() -> Args

Create a new, empty Args list

pub unsafe fn from_raw(a: SoapySDRKwargs) -> Args

Safety

Be careful that SoapySDRKwargs is either:

• SoapySDRKwargs::keys and SoapySDRKwargs::vals are null and SoapySDRKwargs::size is 0 or
• SoapySDRKwargs::keys and SoapySDRKwargs::vals both point to valid keys and vals of SoapySDRKwargs::size length.

pub fn as_raw(&mut self) -> *mut SoapySDRKwargs

pub fn as_raw_const(&self) -> *const SoapySDRKwargs

pub fn set<K: Into<Vec<u8>>, V: Into<Vec<u8>>>(&mut self, key: K, value: V)

Append a key-value pair to the arguments list

Example

use soapysdr::Args;
let mut args = Args::new();
args.set("driver", "lime");

Panics

• if key or value contain null bytes

pub fn get<'a>(&'a self, key: &str) -> Option<&'a str>

Get the value corresponding to a key in the arguments list.

Example:

use soapysdr::Args;
let args: Args = "serial=123456".into();
assert_eq!(args.get("serial"), Some("123456"));

pub fn iter(&self) -> ArgsIterator<'_>

Get an iterator over the (key, value) pairs in the arguments list.

Example:

use soapysdr::Args;
let args: Args = "driver=lime, serial=123456".into();
let mut i = args.iter();
assert_eq!(i.next(), Some(("driver", "lime")));
assert_eq!(i.next(), Some(("serial", "123456")));
assert_eq!(i.next(), None);

Trait Implementations

impl Default for Args

fn default() -> Self

Returns the “default value” for a type.

impl Display for Args

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

Formats the value using the given formatter.

impl Drop for Args

fn drop(&mut self)

Executes the destructor for this type.

impl<'a, K, V> From<&'a [(K, V)]> for Args

where &'a K: Into<Vec<u8>>, &'a V: Into<Vec<u8>>,

fn from(m: &'a [(K, V)]) -> Args

Converts to this type from the input type.

impl<'a> From<&'a Args> for HashMap<String, String>

fn from(a: &'a Args) -> HashMap<String, String>

Converts to this type from the input type.

impl<'a> From<&'a Args> for String

fn from(a: &'a Args) -> String

Converts to this type from the input type.

impl<'a, K: Eq + Hash, V> From<&'a HashMap<K, V>> for Args

where &'a K: Into<Vec<u8>>, &'a V: Into<Vec<u8>>,

fn from(m: &'a HashMap<K, V>) -> Args

Converts to this type from the input type.

impl<'a> From<&'a str> for Args

fn from(s: &'a str) -> Args

Converts to this type from the input type.

impl From<()> for Args

fn from(_: ()) -> Args

Converts to this type from the input type.

impl<K: Into<Vec<u8>>, V: Into<Vec<u8>>> FromIterator<(K, V)> for Args

fn from_iter<T>(i: T) -> Self

where T: IntoIterator<Item = (K, V)>,

Creates a value from an iterator.

impl<'a> IntoIterator for &'a Args

type Item = (&'a str, &'a str)

The type of the elements being iterated over.

type IntoIter = ArgsIterator<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.