larry-robotics / elkodon

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

elk-#3 document public api #52

Closed elfenpiff closed 7 months ago

elfenpiff commented 7 months ago

Notes for Reviewer

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.

Relates to #3

codecov[bot] commented 7 months ago

Codecov Report

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

Comparison is base (dd6bea0) 77.42% compared to head (bf8b0e9) 77.35%.

Files Patch % Lines
elkodon/src/config.rs 65.97% 33 Missing :warning:
...don/src/service/static_config/publish_subscribe.rs 88.46% 3 Missing :warning:
elkodon/src/service/port_factory/event.rs 75.00% 2 Missing :warning:
...odon/src/service/port_factory/publish_subscribe.rs 77.77% 2 Missing :warning:
elkodon/src/port/mod.rs 0.00% 1 Missing :warning:
elkodon/src/service/builder/event.rs 75.00% 1 Missing :warning:
elkodon/src/service/messaging_pattern.rs 94.73% 1 Missing :warning:
elkodon/src/service/process_local.rs 66.66% 1 Missing :warning:
elkodon/src/service/zero_copy.rs 66.66% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #52 +/- ## ========================================== - Coverage 77.42% 77.35% -0.08% ========================================== Files 166 167 +1 Lines 18878 18797 -81 ========================================== - Hits 14617 14540 -77 + Misses 4261 4257 -4 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.