momentohq/client-sdk-rust

audit topics client for consistency with other SDKs

Closed this issue · 0 comments

anitarua commented

Audit: #274
Revision: #276

Follow-up revisions:

  • Rename SubscriptionRequest to SubscribeRequest
  • Update dev docs snippets
  • Add topic client example (including subscribing in spawned thread, cleaning up subscription and thread)
  • Add more docstrings to all topics-related publicly accessible things
  • Mention importing futures when using topics
  • Mention subscriptions must be mut variables in order to call next() and consume messages
  • Make SubscriptionItem publicly accessible
  • Double check IDE autocompletes are reasonable
  • docstring for subscribe includes old optional sequence number args that aren’t actually there
  • docstring for subscribe really needs an example of calling next on the subscription (including the required StreamExt import), it’s very hard to find without that (can be a no_run doctest until #277 is done)