Skip to content

[#602] enforce that payload and header types implement ZeroCopySend #684

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

Conversation

FerdinandSpitzschnueffler
Copy link
Contributor

@FerdinandSpitzschnueffler FerdinandSpitzschnueffler commented Apr 14, 2025

Notes for Reviewer

This PR adds the requirement that every payload and header type must implement ZeroCopySend and adds the helper attribute type_name to the ZeroCopySend derive macro so that a type name can be set when using the macro.

Pre-Review Checklist for the PR Author

  • Add sensible notes for the reviewer
  • PR title is short, expressive and meaningful
  • Consider switching the PR to a draft (Convert to draft)
    • as draft PR, the CI will be skipped for pushes
  • Relevant issues are linked in the References section
  • Every source code file has a copyright header with SPDX-License-Identifier: Apache-2.0 OR MIT
  • Branch follows the naming format (iox2-123-introduce-posix-ipc-example)
  • Commits messages are according to this guideline
  • Tests follow the best practice for testing
  • Changelog updated in the unreleased section including API breaking changes
  • Assign PR to reviewer
  • 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

  • All open points are addressed and tracked via issues

References

Closes #602

Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot reviewed 45 out of 47 changed files in this pull request and generated no comments.

Files not reviewed (2)
  • examples/rust/BUILD.bazel: Language not supported
  • examples/rust/complex_data_types/BUILD.bazel: Language not supported
Comments suppressed due to low confidence (1)

iceoryx2-bb/container/src/queue.rs:262

  • [nitpick] Consider adding an inline comment explaining the safety guarantees required for this unsafe impl of ZeroCopySend for MetaQueue to clarify why it is safe.
unsafe impl<T: ZeroCopySend> ZeroCopySend for MetaQueue<T, GenericRelocatablePointer> {}

Copy link
Contributor

@elfenpiff elfenpiff left a comment

Choose a reason for hiding this comment

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

Looks great, cant wait to merge it!

Only some minor findings.

@FerdinandSpitzschnueffler FerdinandSpitzschnueffler force-pushed the iox2-602-zero-copy-id-attribute branch from e942e2f to 13e4f26 Compare April 15, 2025 10:36
@FerdinandSpitzschnueffler FerdinandSpitzschnueffler merged commit 73d1463 into eclipse-iceoryx:main Apr 16, 2025
52 checks passed
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.

Introduce marker trait for type safe shared memory usage
3 participants