Struct ParamSummary 

pub struct ParamSummary { /* private fields */ }

Structure which holds param summary.

Implementations

impl ParamSummary

Structure implementation.

pub fn with_name<S: Into<String>>( name: S, description: Option<String>, value: Option<String>, default_value: Option<String>, provided: bool, ) -> Self

impl ParamSummary

Structure implementation.

pub fn name(&self) -> &String

Returns name.

pub fn description(&self) -> &Option<String>

Returns description.

pub fn value(&self) -> &Option<String>

Returns value.

pub fn to_value<T>(&self) -> Option<T>

where T: FromStr,

Returns value.

pub fn default_value(&self) -> &Option<String>

Returns default value.

pub fn provided(&self) -> bool

Returns true if the param has value.

Trait Implementations

impl Clone for ParamSummary

fn clone(&self) -> ParamSummary

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParamSummary

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

Formats the value using the given formatter.

impl PartialEq for ParamSummary

fn eq(&self, other: &ParamSummary) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ParamSummary