Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[#488] waitset attachment id improvements #489

Conversation

elfenpiff
Copy link
Contributor

@elfenpiff elfenpiff commented Oct 25, 2024

Notes for Reviewer

To be able to perform better debugging, the streaming operator for the waitset attachment id was added. Furthermore, std::hash was implemented for it to be able to organize it in a hash map.

Pre-Review Checklist for the PR Author

  1. Add sensible notes for the reviewer
  2. PR title is short, expressive and meaningful
  3. Relevant issues are linked in the References section
  4. Every source code file has a copyright header with SPDX-License-Identifier: Apache-2.0 OR MIT
  5. Branch follows the naming format (iox2-123-introduce-posix-ipc-example)
  6. Commits messages are according to this guideline
  7. Tests follow the best practice for testing
  8. Changelog updated in the unreleased section including API breaking changes
  9. Assign PR to reviewer
  10. All checks have passed (except task-list-completed)

Checklist for the PR Reviewer

  • Commits are properly organized and messages are according to the guideline
  • Unit tests have been written for new behavior
  • Public API is documented
  • PR title describes the changes

Post-review Checklist for the PR Author

  1. All open points are addressed and tracked via issues

References

Closes #488

@elfenpiff elfenpiff requested a review from elBoberido October 25, 2024 10:23
@elfenpiff elfenpiff self-assigned this Oct 25, 2024
@elfenpiff elfenpiff force-pushed the iox2-488-waitset-attachment-id-improvements branch from a4dda4b to 75cb1cc Compare October 25, 2024 10:31
Copy link

codecov bot commented Oct 25, 2024

Codecov Report

Attention: Patch coverage is 0% with 8 lines in your changes missing coverage. Please review.

Project coverage is 79.13%. Comparing base (5f6a0dc) to head (355b962).
Report is 6 commits behind head on main.

Files with missing lines Patch % Lines
iceoryx2/src/port/waitset.rs 0.00% 8 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #489      +/-   ##
==========================================
- Coverage   79.19%   79.13%   -0.06%     
==========================================
  Files         200      200              
  Lines       23716    23724       +8     
==========================================
- Hits        18781    18775       -6     
- Misses       4935     4949      +14     
Files with missing lines Coverage Δ
iceoryx2/src/port/waitset.rs 75.68% <0.00%> (-1.89%) ⬇️

... and 6 files with indirect coverage changes

template <ServiceType S>
auto WaitSetAttachmentId<S>::hash() const -> std::size_t {
auto len = iox2_waitset_attachment_id_debug_len(&m_handle);
std::string empty(len, '\0');
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nitpik

Suggested change
std::string empty(len, '\0');
std::string hash(len, '\0');

@elfenpiff elfenpiff merged commit 98a4142 into eclipse-iceoryx:main Oct 25, 2024
44 of 47 checks passed
@elfenpiff elfenpiff deleted the iox2-488-waitset-attachment-id-improvements branch October 25, 2024 15:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Implement streaming operator and std::hash for WaitSetAttachmentId
2 participants