Struct memflow::connector::args::ConnectorArgs

pub struct ConnectorArgs { /* fields omitted */ }

Argument wrapper for connectors

Examples

Construct from a string:

use memflow::connector::ConnectorArgs;
use std::convert::TryFrom;

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

Construct as builder:

use memflow::connector::ConnectorArgs;

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

Implementations

impl ConnectorArgs

pub fn new() -> Self

Creates an empty ConnectorArgs struct.

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

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

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

Tries to create a ConnectorArgs 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.

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::connector::ConnectorArgs;

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

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

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<&String>

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 ConnectorArgs

fn clone(&self) -> ConnectorArgs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConnectorArgs

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

Formats the value using the given formatter.

impl Default for ConnectorArgs

fn default() -> Self

Returns the "default value" for a type.

impl<'_> TryFrom<&'_ str> for ConnectorArgs

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 ConnectorArgs

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.