Group type parameters into CmdCtxTypes.

CHANGELOG.md

@@ -7,12 +7,15 @@
 * Remove requirement to import `peace::cfg::FlowId` when using `flow_id!("..")` macro. ([#157], [#176])
 * Remove requirement to import `peace::cfg::ItemId` when using `item_id!("..")` macro. ([#157], [#176])
 * Remove requirement to import `peace::cfg::Profile` when using `profile!("..")` macro. ([#157], [#176])
+* Add `CmdCtxTypes` to group error, output, and params keys into one type parameter. ([#166], [#177])
 
 
 [#172]: https://github.com/azriel91/peace/issues/172
 [#173]: https://github.com/azriel91/peace/pull/173
 [#157]: https://github.com/azriel91/peace/issues/157
 [#176]: https://github.com/azriel91/peace/pull/176
+[#166]: https://github.com/azriel91/peace/issues/166
+[#177]: https://github.com/azriel91/peace/pull/177
 
 
 ## 0.0.12 (2023-12-30)

Cargo.toml

@@ -93,6 +93,7 @@ peace_rt_model_hack = { path = "crate/rt_model_hack", version = "0.0.12" }
 peace_rt_model_native = { path = "crate/rt_model_native", version = "0.0.12" }
 peace_rt_model_web = { path = "crate/rt_model_web", version = "0.0.12" }
 peace_static_check_macros = { path = "crate/static_check_macros", version = "0.0.12" }
+peace_value_traits = { path = "crate/value_traits", version = "0.0.12" }
 
 # Item crates
 peace_items = { path = "items", version = "0.0.12" }
@@ -107,11 +108,11 @@ peace_item_tar_x = { path = "items/tar_x", version = "0.0.12" }
 # This does not include examples' dependencies, because we want it to be easy for
 # developers to see the dependencies to create an automation tool.
 async-trait = "0.1.77"
-base64 = "0.21.5"
+base64 = "0.21.7"
 bytes = "1.5.0"
 cfg-if = "1.0.0"
-chrono = { version = "0.4.31", default-features = false, features = ["clock", "serde"] }
-console = "0.15.7"
+chrono = { version = "0.4.33", default-features = false, features = ["clock", "serde"] }
+console = "0.15.8"
 derivative = "2.2.0"
 diff-struct = "0.5.3"
 downcast-rs = "1.2.0"
@@ -124,19 +125,19 @@ heck = "0.4.1"
 indexmap = "2.1.0"
 indicatif = "0.17.7"
 interruptible = "0.2.1"
-libc = "0.2.151"
+libc = "0.2.152"
 miette = "5.10.0"
 pretty_assertions = "1.4.0"
-proc-macro2 = "1.0.75"
+proc-macro2 = "1.0.78"
 quote = "1.0.35"
 raw_tty = "0.1.0"
 reqwest = "0.11.23"
 resman = "0.17.0"
-serde = "1.0.194"
+serde = "1.0.196"
 serde-wasm-bindgen = "0.6.3"
-serde_json = "1.0.110"
+serde_json = "1.0.112"
 serde_yaml = "0.9.30"
-syn = "2.0.47"
+syn = "2.0.48"
 tar = "0.4.40"
 tempfile = "3.9.0"
 thiserror = "1.0.56"
@@ -145,5 +146,5 @@ tokio-util = "0.7.10"
 tynm = "0.1.9"
 type_reg = { version = "0.7.0", features = ["debug", "untagged", "ordered"] }
 url = "2.5.0"
-wasm-bindgen = "0.2.89"
-web-sys = "0.3.66"
+wasm-bindgen = "0.2.90"
+web-sys = "0.3.67"

crate/cmd/Cargo.toml

@@ -27,6 +27,7 @@ peace_core = { workspace = true }
 peace_params = { workspace = true }
 peace_resources = { workspace = true }
 peace_rt_model = { workspace = true }
+peace_value_traits = { workspace = true }
 serde = { workspace = true }
 
 [target.'cfg(not(target_arch = "wasm32"))'.dependencies]

crate/cmd/src/ctx.rs

@@ -1,6 +1,15 @@
 //! Types relating to command context.
 
-pub use self::{cmd_ctx::CmdCtx, cmd_ctx_builder::CmdCtxBuilder};
+pub use self::{
+    cmd_ctx::CmdCtx,
+    cmd_ctx_builder::CmdCtxBuilder,
+    cmd_ctx_builder_types::{
+        CmdCtxBuilderTypes, CmdCtxBuilderTypesCollector, CmdCtxTypesCollectorEmpty,
+    },
+    cmd_ctx_types::{CmdCtxTypes, CmdCtxTypesCollector, CmdCtxTypesConstrained},
+};
 
 mod cmd_ctx;
 mod cmd_ctx_builder;
+mod cmd_ctx_builder_types;
+mod cmd_ctx_types;

crate/cmd/src/ctx/cmd_ctx.rs

@@ -3,28 +3,21 @@
 use std::ops::{Deref, DerefMut};
 
 use peace_resources::Resources;
-use peace_rt_model::{
-    params::{KeyUnknown, ParamsKeys, ParamsKeysImpl},
-    Workspace,
-};
+use peace_rt_model::Workspace;
 
 use crate::{
     ctx::{
         cmd_ctx_builder::{
             MultiProfileNoFlowBuilder, MultiProfileSingleFlowBuilder, NoProfileNoFlowBuilder,
             SingleProfileNoFlowBuilder, SingleProfileSingleFlowBuilder,
         },
-        CmdCtxBuilder,
-    },
-    scopes::{
-        type_params::{
-            FlowNotSelected, FlowParamsNone, ProfileNotSelected, ProfileParamsNone,
-            WorkspaceParamsNone,
-        },
-        SingleProfileSingleFlow,
+        CmdCtxBuilder, CmdCtxTypes,
     },
+    scopes::SingleProfileSingleFlow,
 };
 
+use super::CmdCtxTypesCollectorEmpty;
+
 /// Information needed to execute a command.
 ///
 /// Importantly, as commands have different purposes, different command scopes
@@ -50,108 +43,76 @@
 
 impl CmdCtx<()> {
     /// Returns a `CmdCtxBuilder` for a single profile and no flow.
-    pub fn builder_no_profile_no_flow<'ctx, E, O>(
-        output: &'ctx mut O,
+    pub fn builder_no_profile_no_flow<'ctx, AppError, Output>(
+        output: &'ctx mut Output,
         workspace: &'ctx Workspace,
     ) -> CmdCtxBuilder<
         'ctx,
-        O,
-        NoProfileNoFlowBuilder<
-            E,
-            ParamsKeysImpl<KeyUnknown, KeyUnknown, KeyUnknown>,
-            WorkspaceParamsNone,
-        >,
+        CmdCtxTypesCollectorEmpty<AppError, Output>,
+        NoProfileNoFlowBuilder<CmdCtxTypesCollectorEmpty<AppError, Output>>,
     > {
         CmdCtxBuilder::no_profile_no_flow(output, workspace)
     }
 
     /// Returns a `CmdCtxBuilder` for multiple profiles and no flow.
-    pub fn builder_multi_profile_no_flow<'ctx, E, O>(
-        output: &'ctx mut O,
+    pub fn builder_multi_profile_no_flow<'ctx, AppError, Output>(
+        output: &'ctx mut Output,
         workspace: &'ctx Workspace,
     ) -> CmdCtxBuilder<
         'ctx,
-        O,
-        MultiProfileNoFlowBuilder<
-            E,
-            ProfileNotSelected,
-            ParamsKeysImpl<KeyUnknown, KeyUnknown, KeyUnknown>,
-            WorkspaceParamsNone,
-            ProfileParamsNone,
-        >,
+        CmdCtxTypesCollectorEmpty<AppError, Output>,
+        MultiProfileNoFlowBuilder<CmdCtxTypesCollectorEmpty<AppError, Output>>,
     > {
         CmdCtxBuilder::multi_profile_no_flow(output, workspace)
     }
 
     /// Returns a `CmdCtxBuilder` for multiple profiles and one flow.
-    pub fn builder_multi_profile_single_flow<'ctx, E, O>(
-        output: &'ctx mut O,
+    pub fn builder_multi_profile_single_flow<'ctx, AppError, Output>(
+        output: &'ctx mut Output,
         workspace: &'ctx Workspace,
     ) -> CmdCtxBuilder<
         'ctx,
-        O,
-        MultiProfileSingleFlowBuilder<
-            E,
-            ProfileNotSelected,
-            FlowNotSelected,
-            ParamsKeysImpl<KeyUnknown, KeyUnknown, KeyUnknown>,
-            WorkspaceParamsNone,
-            ProfileParamsNone,
-            FlowParamsNone,
-        >,
+        CmdCtxTypesCollectorEmpty<AppError, Output>,
+        MultiProfileSingleFlowBuilder<CmdCtxTypesCollectorEmpty<AppError, Output>>,
     > {
         CmdCtxBuilder::multi_profile_single_flow(output, workspace)
     }
 
     /// Returns a `CmdCtxBuilder` for a single profile and flow.
-    pub fn builder_single_profile_no_flow<'ctx, E, O>(
-        output: &'ctx mut O,
+    pub fn builder_single_profile_no_flow<'ctx, AppError, Output>(
+        output: &'ctx mut Output,
         workspace: &'ctx Workspace,
     ) -> CmdCtxBuilder<
         'ctx,
-        O,
-        SingleProfileNoFlowBuilder<
-            E,
-            ProfileNotSelected,
-            ParamsKeysImpl<KeyUnknown, KeyUnknown, KeyUnknown>,
-            WorkspaceParamsNone,
-            ProfileParamsNone,
-        >,
+        CmdCtxTypesCollectorEmpty<AppError, Output>,
+        SingleProfileNoFlowBuilder<CmdCtxTypesCollectorEmpty<AppError, Output>>,
     > {
         CmdCtxBuilder::single_profile_no_flow(output, workspace)
     }
 
     /// Returns a `CmdCtxBuilder` for a single profile and flow.
-    pub fn builder_single_profile_single_flow<'ctx, E, O>(
-        output: &'ctx mut O,
+    pub fn builder_single_profile_single_flow<'ctx, AppError, Output>(
+        output: &'ctx mut Output,
         workspace: &'ctx Workspace,
     ) -> CmdCtxBuilder<
         'ctx,
-        O,
-        SingleProfileSingleFlowBuilder<
-            E,
-            ProfileNotSelected,
-            FlowNotSelected,
-            ParamsKeysImpl<KeyUnknown, KeyUnknown, KeyUnknown>,
-            WorkspaceParamsNone,
-            ProfileParamsNone,
-            FlowParamsNone,
-        >,
+        CmdCtxTypesCollectorEmpty<AppError, Output>,
+        SingleProfileSingleFlowBuilder<CmdCtxTypesCollectorEmpty<AppError, Output>>,
     > {
         CmdCtxBuilder::single_profile_single_flow(output, workspace)
     }
 }
 
-impl<'ctx, E, O, PKeys, ResTs0> CmdCtx<SingleProfileSingleFlow<'ctx, E, O, PKeys, ResTs0>>
+impl<'ctx, CmdCtxTypesT, ResTs0> CmdCtx<SingleProfileSingleFlow<'ctx, CmdCtxTypesT, ResTs0>>
 where
-    PKeys: ParamsKeys + 'static,
+    CmdCtxTypesT: CmdCtxTypes,
 {
     /// Updates `resources` to a different type state based on the given
     /// function.
     pub fn resources_update<ResTs1, F>(
         self,
         f: F,
-    ) -> CmdCtx<SingleProfileSingleFlow<'ctx, E, O, PKeys, ResTs1>>
+    ) -> CmdCtx<SingleProfileSingleFlow<'ctx, CmdCtxTypesT, ResTs1>>
     where
         F: FnOnce(Resources<ResTs0>) -> Resources<ResTs1>,
     {

crate/cmd/src/ctx/cmd_ctx_builder.rs

@@ -15,8 +15,8 @@ use peace_resources::{
 use peace_rt_model::{
     fn_graph::resman::Resource,
     params::{FlowParams, ProfileParams, WorkspaceParams},
-    Error, Flow, ItemGraph, ParamsSpecsSerializer, ParamsSpecsTypeReg, StatesTypeReg, Storage,
-    Workspace, WorkspaceInitializer,
+    Flow, ItemGraph, ParamsSpecsSerializer, ParamsSpecsTypeReg, StatesTypeReg, Storage, Workspace,
+    WorkspaceInitializer,
 };
 use serde::{de::DeserializeOwned, Serialize};
 
@@ -28,6 +28,8 @@ pub use self::{
     single_profile_single_flow_builder::SingleProfileSingleFlowBuilder,
 };
 
+use crate::ctx::CmdCtxBuilderTypes;
+
 mod multi_profile_no_flow_builder;
 mod multi_profile_single_flow_builder;
 mod no_profile_no_flow_builder;
@@ -36,14 +38,17 @@ mod single_profile_single_flow_builder;
 
 /// Collects parameters and initializes values relevant to the built [`CmdCtx`].
 #[derive(Debug)]
-pub struct CmdCtxBuilder<'ctx, O, ScopeBuilder> {
+pub struct CmdCtxBuilder<'ctx, CmdCtxBuilderTypesT, ScopeBuilder>
+where
+    CmdCtxBuilderTypesT: CmdCtxBuilderTypes,
+{
     /// Output endpoint to return values / errors, and write progress
     /// information to.
     ///
     /// See [`OutputWrite`].
     ///
     /// [`OutputWrite`]: peace_rt_model_core::OutputWrite
-    output: &'ctx mut O,
+    output: &'ctx mut CmdCtxBuilderTypesT::Output,
     /// The interrupt channel receiver if this `CmdExecution` is interruptible.
     interruptibility: Interruptibility<'static>,
     /// Workspace that the `peace` tool runs in.
@@ -57,7 +62,7 @@ async fn workspace_params_serialize<WorkspaceParamsK>(
     workspace_params: &WorkspaceParams<WorkspaceParamsK>,
     storage: &Storage,
     workspace_params_file: &WorkspaceParamsFile,
-) -> Result<(), Error>
+) -> Result<(), peace_rt_model::Error>
 where
     WorkspaceParamsK:
         Clone + Debug + Eq + Hash + DeserializeOwned + Serialize + Send + Sync + 'static,
@@ -94,7 +99,7 @@ async fn profile_params_serialize<ProfileParamsK>(
     profile_params: &ProfileParams<ProfileParamsK>,
     storage: &Storage,
     profile_params_file: &ProfileParamsFile,
-) -> Result<(), Error>
+) -> Result<(), peace_rt_model::Error>
 where
     ProfileParamsK:
         Clone + Debug + Eq + Hash + DeserializeOwned + Serialize + Send + Sync + 'static,
@@ -125,7 +130,7 @@ async fn flow_params_serialize<FlowParamsK>(
     flow_params: &FlowParams<FlowParamsK>,
     storage: &Storage,
     flow_params_file: &FlowParamsFile,
-) -> Result<(), Error>
+) -> Result<(), peace_rt_model::Error>
 where
     FlowParamsK: Clone + Debug + Eq + Hash + DeserializeOwned + Serialize + Send + Sync + 'static,
 {
@@ -139,7 +144,7 @@ async fn params_specs_serialize(
     params_specs: &ParamsSpecs,
     storage: &Storage,
     params_specs_file: &ParamsSpecsFile,
-) -> Result<(), Error> {
+) -> Result<(), peace_rt_model::Error> {
     ParamsSpecsSerializer::serialize(storage, params_specs, params_specs_file).await
 }
 
@@ -267,9 +272,9 @@ fn params_specs_merge<E>(
     flow: &Flow<E>,
     mut params_specs_provided: ParamsSpecs,
     params_specs_stored: Option<ParamsSpecs>,
-) -> Result<ParamsSpecs, Error>
+) -> Result<ParamsSpecs, peace_rt_model::Error>
 where
-    E: From<Error> + 'static,
+    E: From<peace_rt_model::Error> + 'static,
 {
     // Combine provided and stored params specs. Provided params specs take
     // precedence.
@@ -364,7 +369,7 @@ where
     if params_no_issues {
         Ok(params_specs)
     } else {
-        Err(Error::ParamsSpecsMismatch {
+        Err(peace_rt_model::Error::ParamsSpecsMismatch {
             item_ids_with_no_params_specs,
             params_specs_provided_mismatches,
             params_specs_stored_mismatches,

crate/cmd/src/ctx/cmd_ctx_builder/multi_profile_no_flow_builder.rs

@@ -1,5 +1,9 @@
+use crate::ctx::CmdCtxBuilderTypes;
+
 /// Data stored by `CmdCtxBuilder` while building a
 /// `CmdCtx<MultiProfileNoFlow>`.`
 #[peace_code_gen::cmd_ctx_builder_impl]
 #[derive(Debug)]
-pub struct MultiProfileNoFlowBuilder;
+pub struct MultiProfileNoFlowBuilder<CmdCtxBuilderTypesT>
+where
+    CmdCtxBuilderTypesT: CmdCtxBuilderTypes;

crate/cmd/src/ctx/cmd_ctx_builder/multi_profile_single_flow_builder.rs

@@ -1,5 +1,9 @@
+use crate::ctx::CmdCtxBuilderTypes;
+
 /// Data stored by `CmdCtxBuilder` while building a
 /// `CmdCtx<MultiProfileSingleFlow>`.
 #[peace_code_gen::cmd_ctx_builder_impl]
 #[derive(Debug)]
-pub struct MultiProfileSingleFlowBuilder;
+pub struct MultiProfileSingleFlowBuilder<CmdCtxBuilderTypesT>
+where
+    CmdCtxBuilderTypesT: CmdCtxBuilderTypes;

crate/cmd/src/ctx/cmd_ctx_builder/no_profile_no_flow_builder.rs

@@ -1,5 +1,9 @@
+use crate::ctx::CmdCtxBuilderTypes;
+
 /// Data stored by `CmdCtxBuilder` while building a
 /// `CmdCtx<NoProfileNoFlow>`.
 #[peace_code_gen::cmd_ctx_builder_impl]
 #[derive(Debug)]
-pub struct NoProfileNoFlowBuilder;
+pub struct NoProfileNoFlowBuilder<CmdCtxBuilderTypesT>
+where
+    CmdCtxBuilderTypesT: CmdCtxBuilderTypes;