larry-robotics / elkodon

Elkodon - true zero-copy inter-process-communication in rust
Apache License 2.0
16 stars 2 forks source link

elk-#47 Distinguish between 'loan' and 'loan_uninit' for 'Publisher' #64

Closed elBoberido closed 10 months ago

elBoberido commented 10 months ago

Notes for Reviewer

This PR renames loan to loan_uninit and introduces a loan method with Default trait bounds.

The documentation is updated to use write_payload where appropriate which make it possible to use elkodon zero-copy API without unsafe.

Pre-Review Checklist for the PR Author

  1. [x] 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 the SPDX header SPDX-License-Identifier: $(LICENSE_CODE)
  5. [x] Branch follows the naming format (elk-123-introduce-posix-ipc-example)
  6. [x] Commits messages are according to this guideline
    • [x] Commit messages have the issue ID ([#123] Add posix ipc example)
    • [x] Commit author matches Eclipse Contributor Agreement (and ECA is signed)
  7. [x] Tests follow the best practice for testing
  8. [x] Changelog updated in the unreleased section including API breaking changes
  9. [x] Assign PR to reviewer
  10. [x] All checks have passed (except task-list-completed)

Checklist for the PR Reviewer

Post-review Checklist for the PR Author

  1. [x] All open points are addressed and tracked via issues

References

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

Closes #47

codecov[bot] commented 10 months ago

Codecov Report

Merging #64 (a052cde) into main (a0cba7a) will increase coverage by 0.04%. The diff coverage is 100.00%.

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/elkodon/elkodon/pull/64/graphs/tree.svg?width=650&height=150&src=pr&token=57QN0YX5DJ&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=elkodon)](https://app.codecov.io/gh/elkodon/elkodon/pull/64?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=elkodon) ```diff @@ Coverage Diff @@ ## main #64 +/- ## ========================================== + Coverage 77.14% 77.19% +0.04% ========================================== Files 169 169 Lines 18905 18910 +5 ========================================== + Hits 14584 14597 +13 + Misses 4321 4313 -8 ``` | [Files](https://app.codecov.io/gh/elkodon/elkodon/pull/64?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=elkodon) | Coverage Δ | | |---|---|---| | [elkodon/src/port/publisher.rs](https://app.codecov.io/gh/elkodon/elkodon/pull/64?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=elkodon#diff-ZWxrb2Rvbi9zcmMvcG9ydC9wdWJsaXNoZXIucnM=) | `81.15% <100.00%> (+0.27%)` | :arrow_up: | | [elkodon/src/sample\_mut.rs](https://app.codecov.io/gh/elkodon/elkodon/pull/64?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=elkodon#diff-ZWxrb2Rvbi9zcmMvc2FtcGxlX211dC5ycw==) | `85.10% <ø> (+17.02%)` | :arrow_up: | | [elkodon/src/service/port\_factory/publisher.rs](https://app.codecov.io/gh/elkodon/elkodon/pull/64?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=elkodon#diff-ZWxrb2Rvbi9zcmMvc2VydmljZS9wb3J0X2ZhY3RvcnkvcHVibGlzaGVyLnJz) | `56.06% <ø> (ø)` | |