eclipse-iceoryx / iceoryx2

Eclipse iceoryx2™ - true zero-copy inter-process-communication in pure Rust
https://iceoryx.io
Apache License 2.0
1.03k stars 40 forks source link

Improved Getting Started Documentation #446

Open elfenpiff opened 1 month ago

elfenpiff commented 1 month ago

Improvement Suggestion

In https://iceoryx2.readthedocs.io and also our examples we need to clearly define the restrictions on the payload type. On the Rust side we can solve this cleanly with the shmem derive macro but on the C/C++ side we must document it.

It already led to a bug; see #436, so this shall be done sooner rather than later. Otherwise, another user will also run into this pitfall.