Diagram explaining flow

[mkg20001]

Currently trying to make sense of this using diagrams.

(Isn't finished yet - rest() and .stream are missing)

I think it would be a good idea to have some kind of "diagram" like that one for every stream module, to get a better understanding of what these streams actually do

Thoughts?

[jacobheun]

Yes, I think that would be helpful to better illustrate the intended flow. Also, after going through this if you have thoughts on changes to the api, method names, etc, it would be great to hear them. I think renaming some things list rest or simplifying what things are exposed could help make things easier to understand.

[mkg20001]

I think once there's a diagram, complexities will be much easier to spot (pun intended 😉)

(One api change that comes to my mind is to make stream a getter that automatically calls .rest(), but this might break passing the stream before calling .rest(), but unsure if that should even be supported)

Just one thing I can't get my head around: How should I display partially reading from a source and then re-using it in the diagram?

[jacobheun]

Does something like this help? My immediate thought went to a queue like diagram with multiple consumers of chunks from the queue.