iox-#2277 Add nodiscard to iox containers when pushing/emplacing fails

[pbarone-latai]

Notes for Reviewer

This PR adds [[nodiscard]] on any iox container APIs which may fail and return false if a container is at capacity

Pre-Review Checklist for the PR Author

1. [x] Code follows the coding style of CONTRIBUTING.md
2. [x] Tests follow the best practice for testing
3. [x] Changelog updated in the unreleased section including API breaking changes
4. [x] Branch follows the naming format (iox-123-this-is-a-branch)
5. [x] Commits messages are according to this guideline
   • [x] Commit messages have the issue ID (iox-#123 commit text)
   • [x] Commit author matches Eclipse Contributor Agreement (and ECA is signed)
6. [x] Update the PR title
   • Follow the same conventions as for commit messages
   • Link to the relevant issue
7. [x] Relevant issues are linked
8. [x] Add sensible notes for the reviewer
9. [x] All checks have passed (except task-list-completed)
10. [x] Assign PR to reviewer

Checklist for the PR Reviewer

• [ ] Consider a second reviewer for complex new features or larger refactorings
• [ ] Commits are properly organized and messages are according to the guideline
• [ ] Code according to our coding style and naming conventions
• [ ] Unit tests have been written for new behavior
• [ ] Public API changes are documented via doxygen
• [ ] Copyright owner are updated in the changed files
• [ ] All touched (C/C++) source code files from iceoryx_hoofs have been added to ./clang-tidy-diff-scans.txt
• [ ] PR title describes the changes

Post-review Checklist for the PR Author

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

References

• Closes #2277

[elBoberido]

@pbarone-latai any updates on your side?

The issue is that there are quite a few places which now potentially need a IOX_DISCARD_RESULT or an actual check for the return value

[pbarone-latai]

Yeah, unfortunately no update on my end. It was a bit more involved than I initially thought. I don't anticipate having time to do this for a little while, though I do really think it would be worthwhile, both for consumers as well as for iceoryx in general. I'm fine closing the ticket if you don't want to leave the open ticket around

[elBoberido]

@pbarone-latai no problem. Keep your time. It is not necessary to close the PR if you intend to work on it later :)