Crate iceoryx2_bb_elementary

Crate iceoryx2_bb_elementary 

Source
Expand description

Contains basic constructs which do not have any kind of dependency.

Modules§

alignment
Represents the alignment memory can have. Ensures that the content is always a power of 2 and not zero.
bump_allocator
A strong type that represents the alignment part of core::alloc::Layout
cyclic_tagger
Helper struct to tag things cyclicly. For instance in an event loop where all untagged things shall be removed from a list.
enum_gen
Easy enum generation to implement error signaling enums more efficiently.
lazy_singleton
Can be used to implement a singleton object which is not initialized when it is being created.
math
Contains simplistic math functions.
package_version
relocatable_ptr
Building block to handle inter process communication with multiple shared memory object. Every process has mapped them to a different virtual memory location therefore pointer inside that memory region should be distances starting from a fix point which maybe different in every process.
scope_guard
A building block to handle resources that need to be explicitly cleaned up.
static_assert
Static assertions in Rust.
unique_id
Contains two building blocks to generate unique ids. Useful for parallized unit test to generate names which point to OS resources or to enumerate constructs uniquely.
unsendable_marker

Macros§

enum_gen

Enums§

CallbackProgression
Defines how a callback based iteration shall progress after the calling the callback. Either stop the iteration with CallbackProgression::Stop or continue with CallbackProgression::Continue.