search

nats-io / nats.rs

Rust client for NATS, the cloud native messaging system.
Apache License 2.0
980 stars 159 forks source link

Documentation for JetStream Messages needs clarification #1244

Closed ajlane closed 2 months ago

ajlane commented 2 months ago

Observed behavior

I couldn't find the redelivery count for JetStream. Asking on Slack (https://natsio.slack.com/archives/CM3T6T7JQ/p1712473508907169?thread_ts=1712472176.528409&cid=CM3T6T7JQ), it was suggested that the documentation doesn't correctly describe the field that provides it.

In particular, the delivered field on https://docs.rs/nats/latest/nats/jetstream/struct.JetStreamMessageInfo.html does not describe a per message redelivery count.

Expected behavior

Docs correctly and unambiguously describe the purpose of metadata fields.

Server and client version

latest

Host environment

No response

Steps to reproduce

No response

ajlane commented 2 months ago

Brilliant. Might need to check the one in async-nats too?

https://docs.rs/async-nats/latest/async_nats/jetstream/message/struct.Info.html#structfield.delivered

Jarema commented 2 months ago

@ajlane I updated both.