hakuban 0.7.3 → 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/).
 
@@ -24,14 +24,15 @@ Some of Hakuban's features and properties:
 - Allows use of custom de/serializers, uses serde by default.
 - Can be compiled to .so, has ruby binding (ffi), and wasm/js binding.
 
-It's **not** meant for and won't do: message passing, remote function calls, synchronous "calls" (request-response), allow explicit target addressing, be a work-queue, allow "consuming" objects, work directly with any database, modify objects in transit.
+It's **not** meant for and **won't** do: message passing, remote function calls, synchronous "calls" (request-response), allow explicit target addressing, be a work-queue, allow "consuming" objects, work directly with any database, modify objects in transit.
 
 
 ## 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,14 +61,14 @@ 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 progressively)
+* State can be bigger than what fits in a url (as long as it's built progresively)
 * Works while offline/disconnected (no url shortening then)
 
 ### Schedy
@@ -75,20 +76,19 @@ Webapp router, with following properties:
 
 Task queue/scheduler. Aware of resource preparation time. Resources owned and resources required by task are graph-structured.
 
-### [MechaTouch](https://mikoton.com/pages/mechatouch.html)
+### MechaTouch
+`(TODO: add url)`
 
-Commercial (aka. shameless plug) robotic ui-testing platform, with visual test-scenario programming, fully remote SUT control, zero-overhead performance measurements, etc. 
+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 to broken/malicious diffs
-- expose introspection/statistics objects
-- more efficient and simpler network protocol
-- hold un-serialized objects, and serialize only when/if needed
-
+- expose more introspection/statistics objects
+- lazy serialize/deserialize
 ## License
 
 Distributed under the MIT License. See `LICENSE` for more information.
@@ -105,13 +105,12 @@ If you're looking for more intimate contact, talk to `yunta` - on matrix [@yunta
 
 The list does not contain change- or message- focused projects, nor projects with integrated database. Hopefully. It's surprisingly difficult to figure out what some of those actually do:
 * [Redis](https://redis.io)
-* [driftdb](https://driftdb.com/)
+* [Ably](https://ably.com/)
 * [Fluvio](https://www.fluvio.io/)
 * [deepstream](https://deepstream.io/)
-* [zenoh](https://zenoh.io/) 
-* [Ably](https://ably.com/)
+* [nhost](https://nhost.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)
-