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

[#69] port traits #73

Merged
merged 24 commits into from
Jan 26, 2024
Merged

[#69] port traits #73

merged 24 commits into from
Jan 26, 2024

Conversation

elfenpiff
Copy link
Contributor

@elfenpiff elfenpiff commented Jan 5, 2024

Notes for Reviewer

  • All port files were moved to $PORTNAME$_impl.rs and renamed
  • Sample & SampleMut files were moved to $SAMPLE$_impl.rs
  • The traits Listener, Notifier, Publisher, PublisherLoan, Subscriber, Sample, SampleMut, UninitializedSample were introduced

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
  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

Use either 'Closes #123' or 'Relates to #123' to reference the corresponding issue.

Closes #69
Closes #74

Copy link

codecov bot commented Jan 5, 2024

Codecov Report

Attention: 51 lines in your changes are missing coverage. Please review.

Comparison is base (5d91cc7) 78.00% compared to head (023e5e4) 77.97%.
Report is 3 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main      #73      +/-   ##
==========================================
- Coverage   78.00%   77.97%   -0.04%     
==========================================
  Files         172      177       +5     
  Lines       18795    18789       -6     
==========================================
- Hits        14661    14650      -11     
- Misses       4134     4139       +5     
Files Coverage Δ
iceoryx2-bb/elementary/src/enum_gen.rs 33.33% <ø> (ø)
iceoryx2-bb/lock-free/src/spsc/index_queue.rs 93.33% <100.00%> (+0.09%) ⬆️
iceoryx2-bb/lock-free/src/spsc/queue.rs 96.22% <100.00%> (+0.10%) ⬆️
...ck-free/src/spsc/safely_overflowing_index_queue.rs 93.30% <100.00%> (+0.14%) ⬆️
iceoryx2/src/port/details/publisher_connections.rs 90.54% <ø> (+3.52%) ⬆️
iceoryx2/src/port/mod.rs 0.00% <ø> (ø)
iceoryx2/src/port/notifier.rs 85.83% <100.00%> (+5.36%) ⬆️
iceoryx2/src/service/port_factory/listener.rs 60.00% <ø> (ø)
iceoryx2/src/service/port_factory/notifier.rs 87.50% <ø> (ø)
iceoryx2/src/service/port_factory/publisher.rs 59.09% <ø> (ø)
... and 12 more

... and 1 file with indirect coverage changes

Copy link
Member

@elBoberido elBoberido left a comment

Choose a reason for hiding this comment

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

Sorry for leaving the PR for so long. Looks good. Basically just a few naming proposals. Can also be merged as is once the branch is rebased to main.

doc/release-notes/iceoryx2-unreleased.md Outdated Show resolved Hide resolved
doc/release-notes/iceoryx2-unreleased.md Show resolved Hide resolved
iceoryx2/src/port/listener.rs Outdated Show resolved Hide resolved
iceoryx2/src/port/publisher.rs Outdated Show resolved Hide resolved
iceoryx2/src/port/publisher.rs Outdated Show resolved Hide resolved
iceoryx2/src/prelude.rs Outdated Show resolved Hide resolved
iceoryx2/src/sample_mut.rs Outdated Show resolved Hide resolved
iceoryx2/src/sample_mut.rs Outdated Show resolved Hide resolved
iceoryx2/src/sample_mut.rs Outdated Show resolved Hide resolved
iceoryx2/src/sample_mut.rs Outdated Show resolved Hide resolved
…dependent of SubscriberImpl specific generic arguments
}

/// Allows loaning of uninitialized shared memory that can be used for storing the payload of the message.
pub trait UninitLoan<MessageType: Debug> {
Copy link
Member

Choose a reason for hiding this comment

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

Just noticed that the words from the trait are reversed compared to the function, UninitLoan <-> loan_uninit, while they are not in other traits, e.g. SendCopy <-> send_copy

iceoryx2/src/prelude.rs Show resolved Hide resolved
@elfenpiff elfenpiff merged commit 9da8927 into eclipse-iceoryx:main Jan 26, 2024
21 of 23 checks passed
@elfenpiff elfenpiff deleted the iox2-69-ports branch January 26, 2024 22:22
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.

Console logger does not add newlines correctly when redirecting stdout Store ports and samples in container
2 participants