Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Most of the documentation was taken directly from Appendix A of the "Functional Reactive Programming" book and slightly adjusted to match the Rust semantics and documentation conventions.
Since the C++ API documented in that appendix is missing a few things present in the Rust API I had to write the documentation for those items from scratch. Extra scrutiny to those items would be appreciated to ensure their correctness. This includes:
SodiumCtx
docsRouter
docsCellSink::cell
method docsStreamSink::stream
method docsI'm particularly vague on exactly what
Router
does, not having used it personally, though the type signature does seem to describe it fairly well.In addition I hid the documentation for several things that are only incidentally public and not actually intended to be used by library consumers.
This is just a first pass of documentation for the crate. I intend to come back and add more exposition on the crate root and the documentation on each type, eventually including example code.