Crate iceoryx2_bb_elementary

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.
• allocator
  Contains the traits BaseAllocator which contains the most basic functionality an allocator requires and Allocator with more advanced allocation features.
• bump_allocator
  A strong type that represents the alignment part of std::alloc::Layout
• enum_gen
  Easy enum generation to implement error signaling enums more efficiently.
• generic_pointer
• lazy_singleton
  Can be used to implement a singleton object which is not initialized when it is being created.
• math
  Contains simplistic math functions.
• owning_pointer
  Represents a normal non-null pointer. It was introduced to distinguish normal pointers from crate::relocatable_ptr::RelocatablePointer. It implements the PointerTrait.
• package_version
• placement_default
  Trait to perform placement new construction on a given pointer via Default::default(). See PlacementDefault for example.
• pointer_trait
  Trait which describes a form of pointer. Required to distinguish normal pointers from relocatable pointers.
• relocatable_container
  Describes a container which can shared between processes.
• 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.

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.

Traits

• AsCStr
  Trait for types that can be represented as a C-style string.