Struct StringParameter 

pub struct StringParameter {
    pub name: ParameterName,
    pub domain: StringDomain,
    pub constraints: Vec<StringConstraint>,
    pub default: Option<String>,
    pub labels: Labels,
    pub tags: Tags,
}

A parameter that observes a String.

Fields

name: ParameterName

Parameter name.

domain: StringDomain

Value domain (any string or regex-matched).

constraints: Vec<StringConstraint>

Registered constraints.

default: Option<String>

Optional default value.

labels: Labels

Intrinsic facts.

tags: Tags

Organisational tags.

Implementations

impl StringParameter

pub fn of(name: ParameterName) -> Self

Construct a parameter accepting any string.

pub fn regex(name: ParameterName, pattern: impl Into<String>) -> Result<Self>

Construct a parameter restricted to strings matching pattern.

pub fn with_default(self, default: impl Into<String>) -> Result<Self>

Set the default value. Rejects out-of-domain defaults and defaults that violate registered constraints.

pub fn with_constraint(self, c: StringConstraint) -> Self

Append a constraint.

pub fn with_label(self, key: LabelKey, value: LabelValue) -> Result<Self>

Add a label.

pub fn with_tag(self, key: TagKey, value: TagValue) -> Result<Self>

Add a tag.

Trait Implementations

impl Attributed for StringParameter

fn labels(&self) -> &Labels

Intrinsic facts.

fn tags(&self) -> &Tags

Extrinsic organisation.

impl Clone for StringParameter

fn clone(&self) -> StringParameter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StringParameter

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StringParameter

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for StringParameter

fn eq(&self, other: &StringParameter) -> 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 Serialize for StringParameter

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for StringParameter

impl StructuralPartialEq for StringParameter