Struct TypeDescription

pub struct TypeDescription { /* private fields */ }

Human-readable description for a Rust type used in configuration parameter (Boolean value, integer, string etc.).

If a configuration parameter supports complex inputs (objects and/or arrays), this information may contain info on child types (array items; map keys / values).

Implementations

impl TypeDescription

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

Gets the type details.

pub fn unit(&self) -> Option<UnitOfMeasurement>

Gets the unit of measurement.

pub fn items(&self) -> Option<(BasicTypes, &Self)>

Returns the description of array items, if one was provided.

pub fn keys(&self) -> Option<(BasicTypes, &Self)>

Returns the description of map keys, if one was provided.

pub fn values(&self) -> Option<(BasicTypes, &Self)>

Returns the description of map values, if one was provided.

pub fn fallback(&self) -> Option<(BasicTypes, &Self)>

Returns the fallback description, if any.

pub fn contains_secrets(&self) -> bool

Checks whether this type or any child types (e.g., array items or map keys / values) are marked as secret.

pub fn set_details( &mut self, details: impl Into<Cow<'static, str>>, ) -> &mut Self

Sets human-readable type details.

pub fn set_unit(&mut self, unit: UnitOfMeasurement) -> &mut Self

Adds a unit of measurement.

pub fn set_validations<T>( &mut self, validations: &[&'static dyn Validate<T>], ) -> &mut Self

Sets validation for the type.

pub fn set_deserialize_if<T>( &mut self, condition: &'static dyn Validate<T>, ) -> &mut Self

Sets a “deserialize if” condition for the type.

pub fn set_secret(&mut self) -> &mut Self

Marks the value as secret.

pub fn set_items<T: 'static>( &mut self, items: &impl DeserializeParam<T>, ) -> &mut Self

Adds a description of array items. This only makes sense for params accepting array input.

pub fn set_entries<K: 'static, V: 'static>( &mut self, keys: &impl DeserializeParam<K>, values: &impl DeserializeParam<V>, ) -> &mut Self

Adds a description of keys and values. This only makes sense for params accepting object input.

pub fn set_fallback<T: 'static>(&mut self, fallback: &impl DeserializeParam<T>)

Adds a fallback deserializer description.

Trait Implementations

impl Clone for TypeDescription

fn clone(&self) -> TypeDescription

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TypeDescription

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

Formats the value using the given formatter.

impl Default for TypeDescription

fn default() -> TypeDescription

Returns the “default value” for a type.

impl Display for TypeDescription

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

Formats the value using the given formatter.