Add SubscriptionInformation struct to usubscription #179
Conversation
matthewd0123
commented
Aug 7, 2024
matthewd0123
commented
- In uStreamer, there will be a SubscriptionCache that is used to locally track subscriptions coming in from the subscription service. We needed to create a data structure to track these subscriptions, which I have defined here.
* In uStreamer, there will be a SubscriptionCache that is used to locally track subscriptions coming in from the subscription service. We needed to create a data structure to track these subscriptions, which I have defined here.
| @@ -26,6 +26,41 @@ pub use crate::up_core_api::usubscription::{ | |||
|
|
|||
| use crate::{UStatus, UUri}; | |||
|
|
|||
| // Tracks information for the SubscriptionCache | |||
There was a problem hiding this comment.
Use triple forward slashes for doc comments
| // Tracks information for the SubscriptionCache | |
| /// Tracks information for the SubscriptionCache |
There was a problem hiding this comment.
Would be good to expand this a bit with a code usage example a in triple tick block, e.g.
/// ```
/// // put the usage here
/// ```
that way it'll be compiled and tested.
| } | ||
| } | ||
|
|
||
| impl Hash for SubscriptionInformation { |
There was a problem hiding this comment.
Suggest adding similar level of doc comment and doc example as below
| } | ||
| } | ||
|
|
||
| impl Clone for SubscriptionInformation { |
There was a problem hiding this comment.
Do we need to explicitly impl Clone in this case, since all the members are just having .clone() in turn called on them?
Reference this Rust Playground snippet.
Would it suffice to derive Clone for SubscriptionInformation as shown in the snippet?
|
|
||
| impl Eq for SubscriptionInformation {} | ||
|
|
||
| impl PartialEq for SubscriptionInformation { |
There was a problem hiding this comment.
I think some comment explaining the choice to use subscriber as the only member to check equality on would be good.
| } | ||
| } | ||
|
|
||
| impl Hash for SubscriptionInformation { |
There was a problem hiding this comment.
Same sort of comment as above -- good to explain here why only the subscriber is being used in the Hash.
|
Is this struct helpful to other users than uStreamer? If not, I do not see why it should go into up-rust... @PLeVasseur WDYT? |
