Merge branch 'main' into trust

Author: SirCipher

README.md

@@ -1,5 +1,3 @@
-[![Build Status](https://dev.azure.com/swimai-build/swim-rust/_apis/build/status/swimos.swim-rust?branchName=main)](https://dev.azure.com/swimai-build/swim-rust/_build/latest?definitionId=1&branchName=main)
-[![codecov](https://codecov.io/gh/swimos/swim-rust/branch/main/graph/badge.svg?token=IVWBLXCGW8)](https://codecov.io/gh/swimos/swim-rust)
 <a href="https://www.swimos.org"><img src="https://docs.swimos.org/readme/marlin-blue.svg" align="left"></a>
 <br><br><br><br>
 
@@ -19,18 +17,29 @@ will also allow the subscriber to request changes to the state (for lane kinds t
 operate over a web-socket connection and are multiplexed, meaning that links to multiple lanes on the same
 host can share a single web-socket connection.
 
+![SwimOS Crates.io Version](https://img.shields.io/crates/v/swimos?label=swimos) ![SwimOS Form Crates.io Version](https://img.shields.io/crates/v/swimos_form?label=swimos_form) ![SwimOS Client Crates.io Version](https://img.shields.io/crates/v/swimos_client?label=swimos_client)
+
+[Website](https://swimos.org/) | [Developer Guide](https://www.swimos.org/server/rust/developer-guide/) | [Server API Docs](https://docs.rs/swimos/latest/swimos/) | [Client API Docs](https://docs.rs/swimos_client/latest/swimos_client/)
+
 ## Usage Guides
 
 [Implementing Swim Agents in Rust](docs/agent.md)
 
 [Building a Swim Server Application](docs/server.md)
 
+[Reference Documentation](https://www.swimos.org/server/rust/)
+
 ## Examples
 
 The following example application runs a SwimOS server that hosts a single agent route where each agent instance
 has single lane, called `lane`. Each time a changes is made to the lane, it will be printed on the console by the
 server.
 
+```toml
+[dependencies]
+swimos = { version = "0.1.0", features = ["server", "agent"] }
+```
+
 ```rust
 use swimos::{
     agent::{
@@ -46,7 +55,6 @@ use swimos::{
 
 #[tokio::main]
 pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
-    
     // An agent route consists of the agent definition and a lifecycle.
     let model = AgentModel::new(ExampleAgent::default, ExampleLifecycle.into_lifecycle());
 
@@ -80,7 +88,6 @@ struct ExampleLifecycle;
 // annotated event handlers methods in the block.
 #[lifecycle(ExampleAgent)]
 impl ExampleLifecycle {
-    
     #[on_event(lane)]
     fn lane_event(
         &self,
@@ -94,12 +101,11 @@ impl ExampleLifecycle {
             })
         })
     }
-
 }
 ```
 
-For example, if a Swim client sends an update, with the value `5`, to the agent at the URI `/examples/name` for the 
-lane `lane`, an instance of `ExampleAgent`, using `ExampleLifecycle`, will be started by the server. The value of the 
+For example, if a Swim client sends an update, with the value `5`, to the agent at the URI `/examples/name` for the
+lane `lane`, an instance of `ExampleAgent`, using `ExampleLifecycle`, will be started by the server. The value of the
 lane will then be set to `5` and the following will be printed on the console:
 
 ```
@@ -108,4 +114,8 @@ Received value: 5 for 'lane' on agent at URI: /examples/name.
 
 ## Development
 
-See the [development guide](DEVELOPMENT.md).
+See the [development guide](DEVELOPMENT.md).
+
+## License
+
+This project is licensed under the [Apache 2.0 License](LICENSE).

api/formats/swimos_recon/src/comparator/mod.rs

@@ -1,4 +1,4 @@
-// Copyright 2015-2022 Swim Inc.
+// Copyright 2015-2024 Swim Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

api/formats/swimos_recon/src/comparator/tests.rs

@@ -1,4 +1,4 @@
-// Copyright 2015-2022 Swim Inc.
+// Copyright 2015-2024 Swim Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

api/formats/swimos_recon/src/hasher/mod.rs

@@ -1,4 +1,4 @@
-// Copyright 2015-2022 Swim Inc.
+// Copyright 2015-2024 Swim Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

api/formats/swimos_recon/src/hasher/tests.rs

@@ -1,4 +1,4 @@
-// Copyright 2015-2022 Swim Inc.
+// Copyright 2015-2024 Swim Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

api/formats/swimos_recon/src/recon_parser/record/hash.rs

@@ -1,4 +1,4 @@
-// Copyright 2015-2022 Swim Inc.
+// Copyright 2015-2024 Swim Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -11,6 +11,7 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
+
 use super::{separator, AttrBody, EventOrEnd, IncrementalReconParser, ItemsKind, RecBody, Span};
 use crate::hasher::HashError;
 use nom::branch::alt;

api/swimos_api/src/agent/lane/tests.rs

@@ -1,3 +1,17 @@
+// Copyright 2015-2024 Swim Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 use crate::agent::UplinkKind;
 
 use super::WarpLaneKind;

example_apps/README.md

@@ -0,0 +1,30 @@
+# Applications
+
+This directory contains a number of example applications for building SwimOS applications and also contains example
+binaries for their corresponding client applications. Each directory contains details about running the binaries.
+
+- [aggregations](aggregations): Reference code for
+  the [Group and Aggregate Agents](https://www.swimos.org/server/rust/aggregations/) guide.
+- [command_lane](command_lane): Application demonstrating Command Lanes.
+- [demand_lane](demand_lane): Application demonstrating Demand Lanes.
+- [demand_map_lane](demand_map_lane): Application demonstrating Demand Map Lanes.
+- [devguide](devguide): Reference code for the [Developer Guide](https://www.swimos.org/server/rust/developer-guide/).
+- [event_downlink](event_downlink): Application demonstrating Event Downlinks.
+- [http_lane](http_lane): Application demonstrating HTTP Lanes.
+- [join_map](join_map): Application demonstrating Join Map Lanes.
+- [join_value](join_value): Application demonstrating Join Value Lanes.
+- [local_downlink](local_downlink): Application demonstrating Downlinks.
+- [map_downlink](map_downlink): Application demonstrating Map Downlinks.
+- [map_lane](map_lane): Application demonstrating Map Lanes.
+- [map_lane_persistence](map_lane_persistence): Application demonstrating Map Lanes with persistence.
+- [map_store](map_store): Application demonstrating Map Stores.
+- [map_store_persistence](map_store_persistence): Application demonstrating Map Stores with persistence.
+- [supply_lane](supply_lane): Application demonstrating Supply Lanes.
+- [time_series](time_series): Reference code for the [Time Series](https://www.swimos.org/server/rust/time-series/)
+  guide.
+- [transit](transit): Rust port of the [Transit](https://github.com/swimos/transit) application.
+- [value_downlink](value_downlink): Application demonstrating Value Downlinks.
+- [value_lane](value_lane): Application demonstrating Value Lanes.
+- [value_lane_persistence](value_lane_persistence): Application demonstrating Value Lanes with persistence.
+- [value_store](value_store): Application demonstrating Value Stores.
+- [value_store_persistence](value_store_persistence): Application demonstrating Value Stores with persistence.

example_apps/aggregations/src/bin/aggregations_client.rs

@@ -1,3 +1,17 @@
+// Copyright 2015-2024 Swim Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 use std::error::Error;
 use swimos_client::{BasicValueDownlinkLifecycle, RemotePath, SwimClientBuilder};
 

example_apps/aggregations/src/main.rs

@@ -12,6 +12,13 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+//! Reference code for the [Group and Aggregate Agents](https://www.swimos.org/server/rust/aggregations/) guide.
+//!
+//! Run this example using the following:
+//! ```text
+//! $ cargo run --bin aggregations
+//! ```
+
 use std::error::Error;
 use std::str::FromStr;
 use std::time::Duration;