Enum ParamsSpecFieldless 

pub enum ParamsSpecFieldless<T>
where
    T: ParamsFieldless + Clone + Debug + Send + Sync + 'static,
{
    Stored,
    Value {
        value: T,
    },
    InMemory,
    MappingFn(Box<dyn MappingFn<Output = T>>),
}

How to populate a field’s value in an item’s params.

The MappingFn variant’s mapping function is None when deserialized, as it is impossible to determine the underlying F and U type parameters for the backing MappingFnImpl.

For deserialization:

1. A ParamsSpecsTypeReg is constructed, and deserialization functions are registered from ItemId to ParamsSpecFieldlessDe<T, F, U>, where F and U are derived from the ValueSpec provided by the user.

2. value_specs.yaml is deserialized using that type registry.

3. Each ParamsSpecFieldlessDe<T> is mapped into a ParamsSpecFieldless<T>, and subsequently AnySpecRtBoxed to be passed around in a CmdCtx.

4. These AnySpecRtBoxeds are downcasted back to ParamsSpecFieldless<T> when resolving values for item params and params partials.

Variants

Stored

Loads a stored value spec.

The value used is determined by the value spec that was last stored in the params_specs_file. This means it could be loaded as a Value(T) during context build().

This variant may be provided when defining a command context builder. However, this variant is never serialized, but whichever value was first stored is re-loaded then re-serialized.

If no value spec was previously serialized, then the command context build will return an error.

Value

Uses the provided value.

The value used is whatever is passed in to the command context builder.

Fields

value: T

The value to use.

InMemory

Uses a value loaded from resources at runtime.

The value may have been provided by workspace params, or inserted by a predecessor at runtime.

MappingFn(Box<dyn MappingFn<Output = T>>)

Uses a mapped value loaded from resources at runtime.

The value may have been provided by workspace params, or inserted by a predecessor at runtime, and is mapped by the given function.

This is serialized as MappingFn with a string value. For deserialization, there is no actual backing function, so the user must provide the MappingFn in subsequent command context builds.

Implementations

impl<T> ParamsSpecFieldless<T>

where T: ParamsFieldless + Clone + Debug + Send + Sync + 'static,

pub fn from_map<F, Args>(field_name: Option<String>, f: F) -> Self

where MappingFnImpl<T, F, Args>: From<(Option<String>, F)> + MappingFn<Output = T>,

impl<T> ParamsSpecFieldless<T>

where T: ParamsFieldless<Spec = ParamsSpecFieldless<T>> + Clone + Debug + Send + Sync + 'static, T::Partial: From<T>,

pub fn resolve( &self, resources: &Resources<SetUp>, value_resolution_ctx: &mut ValueResolutionCtx, ) -> Result<T, ParamsResolveError>

pub fn resolve_partial( &self, resources: &Resources<SetUp>, value_resolution_ctx: &mut ValueResolutionCtx, ) -> Result<T::Partial, ParamsResolveError>

Trait Implementations

impl<T> AnySpecRt for ParamsSpecFieldless<T>

where T: ParamsFieldless<Spec = ParamsSpecFieldless<T>> + Clone + Debug + Serialize + Send + Sync + 'static,

fn is_usable(&self) -> bool

Whether this Spec is usable to resolve values.

fn merge(&mut self, other_boxed: &dyn AnySpecDataType)

where Self: Sized,

Deep merges the provided AnySpecRt with self, where self takes priority, except for Self::Stored.

impl<T> Clone for ParamsSpecFieldless<T>

where T: ParamsFieldless + Clone + Debug + Send + Sync + 'static + Clone,

fn clone(&self) -> ParamsSpecFieldless<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for ParamsSpecFieldless<T>

where T: ParamsFieldless + Clone + Debug + Send + Sync + 'static,

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for ParamsSpecFieldless<T>

where T: ParamsFieldless + Clone + Debug + Send + Sync + 'static + Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> From<ParamsSpecFieldlessDe<T>> for ParamsSpecFieldless<T>

where T: ParamsFieldless + Clone + Debug + Send + Sync + 'static,

fn from(value_spec_de: ParamsSpecFieldlessDe<T>) -> Self

Converts to this type from the input type.

impl<T> From<T> for ParamsSpecFieldless<T>

where T: ParamsFieldless + Clone + Debug + Send + Sync + 'static,

fn from(value: T) -> Self

Converts to this type from the input type.

impl<T> Serialize for ParamsSpecFieldless<T>

where T: ParamsFieldless + Clone + Debug + Send + Sync + 'static + Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> ValueSpecRt for ParamsSpecFieldless<T>

where T: ParamsFieldless<Spec = ParamsSpecFieldless<T>> + Clone + Debug + Serialize + Send + Sync + 'static + TryFrom<T::Partial>, T::Partial: From<T>,

type ValueType = T

The original value type. MyParamsValueSpec::ValueType is MyParams.

fn resolve( &self, resources: &Resources<SetUp>, value_resolution_ctx: &mut ValueResolutionCtx, ) -> Result<T, ParamsResolveError>

Resolves the value from resources.

fn try_resolve( &self, resources: &Resources<SetUp>, value_resolution_ctx: &mut ValueResolutionCtx, ) -> Result<Option<T>, ParamsResolveError>

Resolves the value from resources, returning None if it is not present.