[#18] Adds formatting for services and an additional example

[hydroid7]

Notes for Reviewer

Here is the pull request with fixed branch name and better formatting.

Pre-Review Checklist for the PR Author

1. [ ] Add sensible notes for the reviewer
2. [x] PR title is short, expressive and meaningful
3. [x] Relevant issues are linked
4. [x] Every source code file has a copyright header with SPDX-License-Identifier: Apache-2.0 OR MIT
5. [x] Branch follows the naming format (iox2-123-introduce-posix-ipc-example)
6. [ ] Commits messages are according to this guideline
   • [ ] Commit messages have the issue ID ([#123] Add posix ipc example)
   • [ ] Commit author matches Eclipse Contributor Agreement (and ECA is signed)
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 #29

[elfenpiff]

@hydroid7 could you please also add this into the doc/release-notes/iceoryx2-unreleased.md release documentation under the features section.

The entry would look somehow like this:

* Add `Display` implementation for `PortFactory` [#29](https://github.com/eclipse-iceoryx/iceoryx2/issues/29)

[codecov[bot]]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (26d979e) 77.97% compared to head (83cb2eb) 78.14%. Report is 6 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #44      +/-   ##
==========================================
+ Coverage   77.97%   78.14%   +0.16%     
==========================================
  Files         172      172              
  Lines       18729    18803      +74     
==========================================
+ Hits        14604    14693      +89     
+ Misses       4125     4110      -15     

Files	Coverage Δ
iceoryx2/src/service/port_factory/event.rs	98.21% <100.00%> (+14.21%)	:arrow_up:
...ryx2/src/service/port_factory/publish_subscribe.rs	100.00% <100.00%> (+10.00%)	:arrow_up:

... and 3 files with indirect coverage changes

[elBoberido]

I did not review the patch but please don't forget why this is done. We want to replace the custom printing code in these to locations

• https://github.com/eclipse-iceoryx/iceoryx2/blob/main/iceoryx2/src/service/port_factory/publish_subscribe.rs#L24-L34
• https://github.com/eclipse-iceoryx/iceoryx2/blob/main/iceoryx2/src/service/port_factory/event.rs#L24-L29

Pleas change those examples to just use println!("{}", pubsub); and println!("{}", event);

Oh, and the PR and commit messages use the wrong issue number. It's actually #18. #29 was the previous PR.

[hydroid7]

Thank you all for the constructive comments, I rewrote the commit messages, added the feature to the releasenotes, changed the documentation in order to reflect the new Display implementation and added the same for pubsub services.

[hydroid7]

Sorry that these took that long, but here they are.

Background for my contributions is that I'm writing a DDS middleware / message broker as my MSc Thesis. Therefore I was first looking at iceoryx, but it was rather hard to use for someone without extensive knowledge in the project.

[elBoberido]

@hydroid7 you need to fix the clippy warnings to make the CI happy

[elBoberido]

@hydroid7 do you plan to finish this PR in the near future?

[elfenpiff]

I think the PR is abandoned for now. @hydroid7 if you would like to continue working on this please feel free to reopen the PR again.