Struct Args

#[repr(C)]
pub struct Args { /* private fields */ }

Argument wrapper for connectors

Examples

Construct from a string:

use memflow::plugins::Args;
use std::convert::TryFrom;

let argstr = "opt1=test1,opt2=test2,opt3=test3";
let args: Args = argstr.parse().unwrap();

Construct as builder:

use memflow::plugins::Args;

let args = Args::new()
    .insert("arg1", "test1")
    .insert("arg2", "test2");

Implementations

impl Args

pub fn new() -> Self

Creates an empty Args struct.

pub fn with_default(value: &str) -> Self

Creates a Args struct with a default (unnamed) value.

pub fn insert(self, key: &str, value: &str) -> Self

Consumes self, inserts the given key-value pair and returns the self again.

This function can be used as a builder pattern when programatically configuring connectors.

Examples

use memflow::plugins::Args;

let args = Args::new()
    .insert("arg1", "test1")
    .insert("arg2", "test2");

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

Tries to retrieve an entry from the options map. If the entry was not found this function returns a None value.

pub fn get_default(&self) -> Option<&str>

Tries to retrieve the default entry from the options map. If the entry was not found this function returns a None value.

This function is a convenience wrapper for args.get("default").

Trait Implementations

impl Clone for Args

fn clone(&self) -> Args

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Args

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

Formats the value using the given formatter.

impl Default for Args

fn default() -> Self

Creates an empty Args struct.

impl<'de> Deserialize<'de> for Args

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Args

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

Generates a string of key-value pairs containing the underlying data of the Args.

This function will produce a string that can be properly parsed by the parse function again.

Remarks

The sorting order of the underlying HashMap is random. This function only guarantees that the ‘default’ value (if it is set) will be the first element.

impl From<Args> for String

fn from(args: Args) -> Self

Converts to this type from the input type.

impl FromStr for Args

fn from_str(s: &str) -> Result<Self>

Tries to create a Args structure from an argument string.

The argument string is a string of comma seperated key-value pairs.

An argument string can just contain keys and values: opt1=val1,opt2=val2,opt3=val3

The argument string can also contain a default value as the first entry which will be placed as a default argument: default_value,opt1=val1,opt2=val2

This function can be used to initialize a connector from user input.

type Err = Error

The associated error which can be returned from parsing.

impl Serialize for Args

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for Args

type Error = Error

The type returned in the event of a conversion error.

fn try_from(args: &str) -> Result<Self>

Performs the conversion.

impl TryFrom<String> for Args

type Error = Error

The type returned in the event of a conversion error.

fn try_from(args: String) -> Result<Self>

Performs the conversion.