diff --git a/Cargo.toml b/Cargo.toml index 9606d7d..8f22413 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -30,8 +30,12 @@ tracing-subscriber = "0.3.18" kafka = ["samsa"] [[example]] -name = "loader" -path = "example/loader.rs" +name = "shakespeare_consumer" +path = "example/shakespeare_consumer.rs" + +[[example]] +name = "shakespeare_loader" +path = "example/shakespeare_loader.rs" [[example]] name = "stocks" diff --git a/README.md b/README.md index afa6430..da6708b 100644 --- a/README.md +++ b/README.md @@ -13,17 +13,24 @@ A stream is an asyncronous iterator. It is any structure that implements the Str #### Table A table is a streaming data structure that keeps the latest state for each incoming key. The structure can be referenced like a map/dictionary, and also lets the incoming messages flow through through to be used elsewhere. +![table](img/table.png) + #### Actor An actor is a `tokio` task that executes a stream. It accepts a input stream and returns an output stream. Actors do the work that is defined on a stream. These are useful when you want to build complex stream processing pipelines. One use case is to break up processing into multiple steps so that you can do things with the partial results. +![actor](img/actor.png) + #### Sink Sinks accept streams and dump the data elsewhere. Typically these are where the flow of the data in an rstreams program terminate. +![sink](img/sink.png) + #### Source Sources get data from elsewhere and return that data in a stream. Typically these are at the beginning of flow in an rstreams program. +![source](img/source.png) ## Current supported features diff --git a/img/actor.png b/img/actor.png new file mode 100644 index 0000000..af22e54 Binary files /dev/null and b/img/actor.png differ diff --git a/img/sink.png b/img/sink.png new file mode 100644 index 0000000..0f82314 Binary files /dev/null and b/img/sink.png differ diff --git a/img/source.png b/img/source.png new file mode 100644 index 0000000..bf14c4d Binary files /dev/null and b/img/source.png differ diff --git a/img/table.png b/img/table.png new file mode 100644 index 0000000..5819a9a Binary files /dev/null and b/img/table.png differ