hakuban 0.6.2 → 0.7.0

package/README.md

@@ -17,32 +17,35 @@ Some of Hakuban's features and properties:
 - Object identifiers are "rich" (json), not just strings. So, for example, complex user-defined search filter on a web page, expressed as json, can directly act as an identifier of the object holding results of that search.
 - Object can belong to zero or more tags, which function as wildcards for exposing or observing unknown objects.
 - Supports tree network topology, with leafs happily unaware of anything not relevant to them.
-- Nodes on all levels can observe and expose alike, unlike in most database/graphql-centric solutions.
+- Exchanges on all levels can observe and expose alike, unlike in most database/graphql-centric solutions.
 - At most one exposer is selected for each object to keep it up to date. With load balancing.
-- Thread-safe core, works with async and sync code, delivers events as streams, iterators or callbacks.
+- Thread-safe core, delivers data with streams, accepts data with sinks.
 - Core is not bound to any specific async-runtime. First implemented network transport uses websockets on tokio.
 - Allows use of custom de/serializers, uses serde by default.
-- Can be compiled to .so, has ruby binding (ffi), and wasm binding in the near future.
+- 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.
 
 
 ## Usage example
 ```rust
-let hakuban = hakuban::LocalNode::builder().build();
-let observe = hakuban.object((["some-tag"],"xxx")).observe::<String>();
-
-std::thread::spawn(move || {
-	let expose = hakuban.object((["some-tag"],"xxx")).expose();
-	expose.set_object_data(&"aaaaaa");
+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();
+
+tokio::spawn(async move {
+	//ExposeContract emits ObjectStateSink when first observer appears
+	let mut object_state_sink = expose_contract.next().await.unwrap();
+	let object_state = ObjectState::new("my data").json_serialize();
+	object_state_sink.send(object_state).await;
 });
 
-for _event in observe.changes() {
-	if let Some(data) = observe.object_data()? {
-		println!("{}", data);
-		break;
-	}
-}
+tokio::spawn(async move {
+	//ObserveContract emits ObjectStateStream when exposer uploads first ObjectState
+	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);
+});
 ```
 
 For more examples check out the `examples` directory, and [documentation](https://docs.rs/hakuban/).
@@ -63,7 +66,7 @@ Hakuban compiled to wasm, with JS interface to use in browser.
 Webapp router, with following properties:
 * Every link is open-in-new-tab compatible, and copy-link compatible
 * Short urls, optionally exposing selected state variables
-* All urls are shareable
+* All urls (== application states) are shareable
 * 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)
 
@@ -83,10 +86,8 @@ Not ordered by priority:
 - avoid object flicker on short disconnections
 - message filter for auth* and auditing
 - immunity from broken/malicious diffs
-- make event pipeline elements destructible
 - expose introspection/statistics objects
-- simplify assignment API
-
+- more efficient and simpler network protocol
 
 ## License
 
@@ -95,7 +96,7 @@ Distributed under the MIT License. See `LICENSE` for more information.
 
 ## Contact
 
-To get help, praise the author(s), laugh at problems of others, or just hang around observing progress - join hakuban's matrix channel [#hakuban:matrix.org](matrix:r/hakuban:example.org)
+To get help, praise the author(s), laugh at problems of others, or just hang around observing progress - join hakuban's matrix channel [#hakuban:matrix.org](matrix:r/hakuban:matrix.org)
 
 If you're looking for more intimate contact, talk to `yunta` - on matrix [@yunta:mikoton.com](matrix:u/yunta:mikoton.com), or email yunta@mikoton.com.