hakuban 0.7.1 → 0.8.0

package/README.md

@@ -2,9 +2,9 @@
 
 Convenient data-object sharing library.
 
-Are you tired of handling all the little details of propagating object states? 
-Computing differences, serialization, network propagation (timeouts, keep-alives, ...), somehow catching-up on reconnection, 
-load balancing object production, event delivery, object lifetime control etc. **Hakuban does all of that for you.** 
+Are you tired of handling all the little details of propagating object states?
+Computing differences, serialization, network propagation (timeouts, keep-alives, ...), somehow catching-up on reconnection,
+load balancing object production, event delivery, object lifetime control etc. **Hakuban does all of that for you.**
 
 For details on structs, modules, cargo feature flags, event handling, etc. head on to [documentation](https://docs.rs/hakuban/).
 
@@ -29,9 +29,10 @@ It's **not** meant for and **won't** do: message passing, remote function calls,
 
 ## Usage example
 ```rust
-let exchange = LocalExchange::builder().build();
-let mut observe_contract = exchange.object((["some-tag"],"xxx")).observe();
-let mut expose_contract = exchange.object((["some-tag"],"xxx")).expose();
+let exchange = Exchange::new();
+
+let mut observe_contract = exchange.object_observe_contract((["some-tag"],"xxx")).build();
+let mut expose_contract = exchange.object_expose_contract((["some-tag"],"xxx")).build();
 
 tokio::spawn(async move {
 	//ExposeContract emits ObjectStateSink when first observer appears
@@ -41,7 +42,7 @@ tokio::spawn(async move {
 });
 
 tokio::spawn(async move {
-	//ObserveContract emits ObjectStateStream when exposer uploads first ObjectState
+	//ObserveContract emits ObjectStateStream
 	let mut object_state_stream = observe_contract.next().await.unwrap();
 	let object_state = object_state_stream.next().await.unwrap().json_deserialize::<String>();
 	println!("{:?}", object_state.data);
@@ -60,11 +61,11 @@ Hakuban ruby ffi binding.
 
 Hakuban compiled to wasm, with JS interface to use in browser.
 
-### Hakuban webapp router 
+### Hakuban webapp state manager
 `(TODO: add url)`
 
-Webapp router, with following properties:
-* Every link is open-in-new-tab compatible, and copy-link compatible
+Webapp state manager, with:
+* Every link being open-in-new-tab compatible, and copy-link compatible
 * Short urls, optionally exposing selected state variables
 * All urls (== application states) are shareable
 * State can be bigger than what fits in a url (as long as it's built progresively)
@@ -82,13 +83,12 @@ Commercial (aka. shameless plug) robotic ui-testing platform.
 
 ## Roadmap
 Not ordered by priority:
+- actor-ish api. allowing registration of object-producing lambdas, to be instantiated on demand in separate tasks.
+- object signing, and access tokens
 - preloading/side loading
-- avoid object flicker on short disconnections
-- message filter for auth* and auditing
-- immunity from broken/malicious diffs
-- expose introspection/statistics objects
-- more efficient and simpler network protocol
-
+- immunity to broken/malicious diffs
+- expose more introspection/statistics objects
+- lazy serialize/deserialize
 ## License
 
 Distributed under the MIT License. See `LICENSE` for more information.
@@ -109,9 +109,8 @@ The list does not contain change- or message- focused projects, nor projects wit
 * [Fluvio](https://www.fluvio.io/)
 * [deepstream](https://deepstream.io/)
 * [nhost](https://nhost.io/)
-* [zenoh](https://zenoh.io/) 
+* [zenoh](https://zenoh.io/)
 * just diffing, if you don't need the network and lifetime control parts:
 	* [serde-diff](https://github.com/amethyst/serde-diff)
 	* [dipa](https://github.com/chinedufn/dipa)
 	* [deltoid](https://github.com/jjpe/deltoid)
-