C++ API

rcpputils: ROS 2 C++ Utilities

rcpputils is a C++ API consisting of macros, functions, and data structures intended for use throughout the ROS 2 codebase

Quality Declaration

This package claims to be in the Quality Level 1 category, see the Quality Declaration for more details.

API

This package currently contains:

• Assertion functions

• Clang thread safety annotation macros

• Library discovery

• String helpers

• File system helpers

• Type traits helpers

• Class that dynamically loads, unloads and get symbols from shared libraries at run-time.

Features are described in more detail at docs/FEATURES.md

Page Hierarchy

• • QUALITY_DECLARATION
  • CONTRIBUTING
  • rcpputils Features

Class Hierarchy

• • Namespace rcpputils
    • Namespace rcpputils::fs
      • Class path
    • Template Struct is_pointer
    • Template Struct remove_pointer
    • Template Struct scope_exit
    • Class AssertionException
    • Class IllegalStateException
    • Template Class RollingMeanAccumulator
    • Class SharedLibrary
    • Template Class unique_lock
    • Enum endian
  • Namespace tl
    • Struct in_place_t
    • Struct unexpect_t
    • Template Class bad_expected_access
    • Template Class expected
    • Class monostate
    • Template Class unexpected

File Hierarchy

• • Directory docs
    • File FEATURES.md
  • Directory include
    • Directory rcppmath
      • File clamp.hpp
      • File rolling_mean_accumulator.hpp
    • Directory rcpputils
      • Directory tl_expected
        • File expected.hpp
      • File asserts.hpp
      • File endian.hpp
      • File env.hpp
      • File filesystem_helper.hpp
      • File find_and_replace.hpp
      • File find_library.hpp
      • File get_env.hpp
      • File join.hpp
      • File pointer_traits.hpp
      • File process.hpp
      • File rolling_mean_accumulator.hpp
      • File scope_exit.hpp
      • File shared_library.hpp
      • File split.hpp
      • File thread_safety_annotations.hpp
      • File time.hpp
      • File unique_lock.hpp
      • File visibility_control.hpp
  • File CONTRIBUTING.md
  • File QUALITY_DECLARATION.md
  • File README.md

Full C++ API

Namespaces

• Namespace rcppmath

• Namespace rcpputils

• Namespace rcpputils::fs

• Namespace std

• Namespace std::conditional

• Namespace tl

Classes and Structs

• Template Struct is_pointer

• Template Struct remove_pointer

• Template Struct scope_exit

• Struct in_place_t

• Struct unexpect_t

• Class AssertionException

• Class path

• Class IllegalStateException

• Template Class RollingMeanAccumulator

• Class SharedLibrary

• Template Class unique_lock

• Template Class bad_expected_access

• Template Class expected

• Class monostate

• Template Class unexpected

Enums

• Enum endian

Functions

• Function operator!

• Template Function rcppmath::clamp(const T&, const T&, const T&)

• Template Function rcppmath::clamp(const T&, const T&, const T&, Compare)

• Function rcpputils::assert_true

• Function rcpputils::check_true

• Template Function rcpputils::convert_to_nanoseconds

• Function rcpputils::filename_for_library

• Template Function rcpputils::find_and_replace(const std::basic_string<CharT, Traits, Allocator>&, const std::basic_string<CharT, Traits, Allocator>&, const std::basic_string<CharT, Traits, Allocator>&)

• Template Function rcpputils::find_and_replace(InputT&&, FindT&&, ReplaceT&&)

• Function rcpputils::find_library_path

• Function rcpputils::fs::create_directories

• Function rcpputils::fs::create_temp_directory

• Function rcpputils::fs::current_path

• Function rcpputils::fs::exists

• Function rcpputils::fs::file_size

• Function rcpputils::fs::is_directory

• Function rcpputils::fs::is_regular_file

• Function rcpputils::fs::operator!=

• Function rcpputils::fs::operator<<

• Function rcpputils::fs::operator==

• Function rcpputils::fs::remove

• Function rcpputils::fs::remove_all

• Function rcpputils::fs::remove_extension

• Function rcpputils::fs::temp_directory_path

• Function rcpputils::get_env_var

• Function rcpputils::get_executable_name

• Function rcpputils::get_platform_library_name

• Template Function rcpputils::join

• Template Function rcpputils::make_scope_exit

• Function rcpputils::path_for_library

• Function rcpputils::require_true

• Function rcpputils::set_env_var

• Function rcpputils::split

• Template Function tl::make_unexpected

• Template Function tl::operator!=(const unexpected<E>&, const unexpected<E>&)

• Template Function tl::operator!=(const expected<T, E>&, const expected<U, F>&)

• Template Function tl::operator!=(const expected<T, E>&, const U&)

• Template Function tl::operator!=(const U&, const expected<T, E>&)

• Template Function tl::operator!=(const expected<T, E>&, const unexpected<E>&)

• Template Function tl::operator!=(const unexpected<E>&, const expected<T, E>&)

• Template Function tl::operator<

• Template Function tl::operator<=

• Template Function tl::operator==(const unexpected<E>&, const unexpected<E>&)

• Template Function tl::operator==(const expected<T, E>&, const expected<U, F>&)

• Template Function tl::operator==(const expected<T, E>&, const U&)

• Template Function tl::operator==(const U&, const expected<T, E>&)

• Template Function tl::operator==(const expected<T, E>&, const unexpected<E>&)

• Template Function tl::operator==(const unexpected<E>&, const expected<T, E>&)

• Template Function tl::operator>

• Template Function tl::operator>=

• Template Function tl::swap

Variables

• Variable rcpputils::fs::kPreferredSeparator

• Variable tl::in_place

• Variable tl::unexpect

Defines

• Define RCPPUTILS_EXPORT

• Define RCPPUTILS_IMPL_OS_DIRSEP

• Define RCPPUTILS_IMPORT

• Define RCPPUTILS_LOCAL

• Define RCPPUTILS_NO_STD_ENDIAN

• Define RCPPUTILS_PUBLIC

• Define RCPPUTILS_PUBLIC_TYPE

• Define RCPPUTILS_SCOPE_EXIT

• Define RCPPUTILS_THREAD_ANNOTATION_ATTRIBUTE_IMPL

• Define RCPPUTILS_TSA_ACQUIRE

• Define RCPPUTILS_TSA_ACQUIRE_SHARED

• Define RCPPUTILS_TSA_ACQUIRED_AFTER

• Define RCPPUTILS_TSA_ACQUIRED_BEFORE

• Define RCPPUTILS_TSA_ASSERT_CAPABILITY

• Define RCPPUTILS_TSA_ASSERT_SHARED_CAPABILITY

• Define RCPPUTILS_TSA_CAPABILITY

• Define RCPPUTILS_TSA_EXCLUDES

• Define RCPPUTILS_TSA_GUARDED_BY

• Define RCPPUTILS_TSA_NO_THREAD_SAFETY_ANALYSIS

• Define RCPPUTILS_TSA_PT_GUARDED_BY

• Define RCPPUTILS_TSA_RELEASE

• Define RCPPUTILS_TSA_RELEASE_SHARED

• Define RCPPUTILS_TSA_REQUIRES

• Define RCPPUTILS_TSA_REQUIRES_SHARED

• Define RCPPUTILS_TSA_RETURN_CAPABILITY

• Define RCPPUTILS_TSA_SCOPED_CAPABILITY

• Define RCPPUTILS_TSA_TRY_ACQUIRE

• Define RCPPUTILS_TSA_TRY_ACQUIRE_SHARED

• Define TL_EXPECTED_11_CONSTEXPR

• Define TL_EXPECTED_GCC49_CONSTEXPR

• Define TL_EXPECTED_IS_TRIVIALLY_COPY_ASSIGNABLE

• Define TL_EXPECTED_IS_TRIVIALLY_COPY_CONSTRUCTIBLE

• Define TL_EXPECTED_IS_TRIVIALLY_DESTRUCTIBLE

• Define TL_EXPECTED_MSVC2015_CONSTEXPR

• Define TL_EXPECTED_VERSION_MAJOR

• Define TL_EXPECTED_VERSION_MINOR

• Define TL_EXPECTED_VERSION_PATCH

• Define TL_MONOSTATE_INPLACE_MUTEX

• Define TL_TRAITS_MUTEX

Typedefs

• Typedef rcppmath::RollingMeanAccumulator

Directories

• Directory docs

• Directory include

• Directory rcppmath

• Directory rcpputils

• Directory tl_expected

Files

• File asserts.hpp

• File clamp.hpp

• File CONTRIBUTING.md

• File endian.hpp

• File env.hpp

• File expected.hpp

• File FEATURES.md

• File filesystem_helper.hpp

• File find_and_replace.hpp

• File find_library.hpp

• File get_env.hpp

• File join.hpp

• File pointer_traits.hpp

• File process.hpp

• File QUALITY_DECLARATION.md

• File README.md

• File rolling_mean_accumulator.hpp

• File rolling_mean_accumulator.hpp

• File scope_exit.hpp

• File shared_library.hpp

• File split.hpp

• File thread_safety_annotations.hpp

• File time.hpp

• File unique_lock.hpp

• File visibility_control.hpp

Pages

• QUALITY_DECLARATION

• CONTRIBUTING

• rcpputils Features