Tided up docs for the agent module.

swimos · Jun 20, 2024 · 4a4ad2a · 4a4ad2a
1 parent e0c2c2c
commit 4a4ad2a
Show file tree

Hide file tree

Showing 9 changed files with 163 additions and 141 deletions.
diff --git a/docs/downlink.md b/docs/downlink.md
@@ -77,7 +77,7 @@ the agent at `"/node"` on the host `"swim://example.remote:8080"`. Here `OpenVal
 a `HandlerAction` that results in a value of type:
 
 ```rust
-swimos::agent::agent_model::downlink::hosted::ValueDownlinkHandle
+swimos::agent::agent_model::downlink::ValueDownlinkHandle
 ```
 
 This handle can be used to set the value of the remote lane, through the downlink.

diff --git a/example_apps/event_downlink/src/consumer/agent.rs b/example_apps/event_downlink/src/consumer/agent.rs
@@ -14,7 +14,7 @@
 
 use swimos::agent::{
     agent_lifecycle::HandlerContext,
-    agent_model::downlink::hosted::EventDownlinkHandle,
+    agent_model::downlink::EventDownlinkHandle,
     event_handler::{EventHandler, HandlerAction, HandlerActionExt},
     lanes::{CommandLane, ValueLane},
     lifecycle, projections,

diff --git a/example_apps/local_downlink/src/consumer/agent.rs b/example_apps/local_downlink/src/consumer/agent.rs
@@ -14,7 +14,7 @@
 
 use swimos::agent::{
     agent_lifecycle::HandlerContext,
-    agent_model::downlink::hosted::ValueDownlinkHandle,
+    agent_model::downlink::ValueDownlinkHandle,
     event_handler::{EventHandler, HandlerAction, HandlerActionExt},
     lanes::{CommandLane, ValueLane},
     lifecycle, projections,

diff --git a/example_apps/map_downlink/src/consumer/agent.rs b/example_apps/map_downlink/src/consumer/agent.rs
@@ -15,7 +15,7 @@
 use example_util::format_map;
 use swimos::agent::{
     agent_lifecycle::HandlerContext,
-    agent_model::downlink::hosted::MapDownlinkHandle,
+    agent_model::downlink::MapDownlinkHandle,
     event_handler::{EventHandler, HandlerAction, HandlerActionExt},
     lanes::{CommandLane, ValueLane},
     lifecycle, projections,

diff --git a/example_apps/value_downlink/src/consumer/agent.rs b/example_apps/value_downlink/src/consumer/agent.rs
@@ -14,7 +14,7 @@
 
 use swimos::agent::{
     agent_lifecycle::HandlerContext,
-    agent_model::downlink::hosted::ValueDownlinkHandle,
+    agent_model::downlink::ValueDownlinkHandle,
     event_handler::{EventHandler, HandlerAction, HandlerActionExt},
     lanes::{CommandLane, ValueLane},
     lifecycle, projections,

diff --git a/server/swimos_agent/src/lib.rs b/server/swimos_agent/src/lib.rs
@@ -38,7 +38,7 @@ pub mod agent_lifecycle;
 /// and stores.
 pub mod agent_model;
 
-/// Configuration types for downlinks started from agent lifecycles.
+/// Configuration types for downlinks that are started from agent lifecycles.
 pub mod config;
 
 /// Traits and builders for constructing downlink lifecycles for downlinks started from agent lifecycles.

diff --git a/swimos/Cargo.toml b/swimos/Cargo.toml
@@ -20,6 +20,7 @@ swimos_server_app = { path = "../server/swimos_server_app", optional = true }
 swimos_agent = { path = "../server/swimos_agent", optional = true }
 swimos_agent_derive = { path = "../server/swimos_agent_derive", optional = true }
 swimos_remote = { path = "../runtime/swimos_remote", optional = true}
+swimos_form = { path = "../api/swimos_form" }
 
 [dev-dependencies]
 parking_lot = { workspace = true }