iceoryx2
C++ Language Bindings
Loading...
Searching...
No Matches
iox2::bb::StaticString< N >::UncheckedAccessor Class Reference

#include <static_string.hpp>

Public Member Functions

 ~UncheckedAccessor ()=default
 
 UncheckedAccessor (UncheckedAccessor const &)=delete
 
 UncheckedAccessor (UncheckedAccessor &&)=default
 
auto operator= (UncheckedAccessor const &) -> UncheckedAccessor &=delete
 
auto operator= (UncheckedAccessor &&) -> UncheckedAccessor &=delete
 
constexpr auto operator[] (SizeType index) -> Reference
 
constexpr auto begin () noexcept -> Iterator
 
constexpr auto end () noexcept -> Iterator
 
constexpr auto data () noexcept -> Pointer
 
constexpr auto c_str () noexcept -> char const *
 

Friends

class StaticString
 

Detailed Description

template<uint64_t N>
class iox2::bb::StaticString< N >::UncheckedAccessor

The unchecked API provided by this class allows for uncontrolled memory access and encoding violations. Users of this class must ensure that all memory accesses stay within bounds of the accessed string memory. Users of this class must ensure that writes to the string do not result in a sequence of bytes that is no longer a valid UTF-8 encoded string. This includes not setting any of the string characters to NUL (U+0000).

Definition at line 143 of file static_string.hpp.

Constructor & Destructor Documentation

◆ ~UncheckedAccessor()

template<uint64_t N>
iox2::bb::StaticString< N >::UncheckedAccessor::~UncheckedAccessor ( )
default

◆ UncheckedAccessor() [1/2]

template<uint64_t N>
iox2::bb::StaticString< N >::UncheckedAccessor::UncheckedAccessor ( UncheckedAccessor const &  )
delete

◆ UncheckedAccessor() [2/2]

template<uint64_t N>
iox2::bb::StaticString< N >::UncheckedAccessor::UncheckedAccessor ( UncheckedAccessor &&  )
default

Member Function Documentation

◆ begin()

template<uint64_t N>
constexpr auto iox2::bb::StaticString< N >::UncheckedAccessor::begin ( ) -> Iterator
inlineconstexprnoexcept

Definition at line 165 of file static_string.hpp.

◆ c_str()

template<uint64_t N>
constexpr auto iox2::bb::StaticString< N >::UncheckedAccessor::c_str ( ) -> char const*
inlineconstexprnoexcept

◆ data()

template<uint64_t N>
constexpr auto iox2::bb::StaticString< N >::UncheckedAccessor::data ( ) -> Pointer
inlineconstexprnoexcept

◆ end()

template<uint64_t N>
constexpr auto iox2::bb::StaticString< N >::UncheckedAccessor::end ( ) -> Iterator
inlineconstexprnoexcept

Definition at line 169 of file static_string.hpp.

◆ operator=() [1/2]

template<uint64_t N>
auto iox2::bb::StaticString< N >::UncheckedAccessor::operator= ( UncheckedAccessor &&  ) -> UncheckedAccessor &=delete
delete

◆ operator=() [2/2]

template<uint64_t N>
auto iox2::bb::StaticString< N >::UncheckedAccessor::operator= ( UncheckedAccessor const &  ) -> UncheckedAccessor &=delete
delete

◆ operator[]()

template<uint64_t N>
constexpr auto iox2::bb::StaticString< N >::UncheckedAccessor::operator[] ( SizeType  index) -> Reference
inlineconstexpr

Definition at line 161 of file static_string.hpp.

Friends And Related Symbol Documentation

◆ StaticString

template<uint64_t N>
friend class StaticString
friend

Definition at line 144 of file static_string.hpp.


The documentation for this class was generated from the following file: