iox2::bb::StaticString< N >::ConstAccessorCodeUnits Class Reference

This class provides the interface for accessing individual code units of the string. More...

#include <static_string.hpp>

Public Member Functions
	~ConstAccessorCodeUnits ()=default
	ConstAccessorCodeUnits (ConstAccessorCodeUnits const &)=delete
	ConstAccessorCodeUnits (ConstAccessorCodeUnits &&)=default
auto	operator= (ConstAccessorCodeUnits const &) -> ConstAccessorCodeUnits &=delete
auto	operator= (ConstAccessorCodeUnits &&) -> ConstAccessorCodeUnits &=delete
auto	element_at (SizeType index) const noexcept -> OptionalConstCodeUnitReference
auto	front_element () const noexcept -> OptionalConstCodeUnitReference
auto	back_element () const noexcept -> OptionalConstCodeUnitReference

Friends
class	StaticString
auto	bb::detail::is_valid_path_to_file (const bb::StaticString< N > &name) noexcept -> bool
auto	bb::detail::is_valid_path_to_directory (const bb::StaticString< N > &name) noexcept -> bool

Detailed Description

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

This class provides the interface for accessing individual code units of the string.

Definition at line 292 of file static_string.hpp.

Constructor & Destructor Documentation

~ConstAccessorCodeUnits()

template<uint64_t N>

iox2::bb::StaticString< N >::ConstAccessorCodeUnits::~ConstAccessorCodeUnits ( )

default

ConstAccessorCodeUnits() [1/2]

template<uint64_t N>

iox2::bb::StaticString< N >::ConstAccessorCodeUnits::ConstAccessorCodeUnits ( ConstAccessorCodeUnits const &  )

delete

ConstAccessorCodeUnits() [2/2]

template<uint64_t N>

iox2::bb::StaticString< N >::ConstAccessorCodeUnits::ConstAccessorCodeUnits ( ConstAccessorCodeUnits &&  )

default

Member Function Documentation

back_element()

template<uint64_t N>

auto iox2::bb::StaticString< N >::ConstAccessorCodeUnits::back_element ( ) const -> OptionalConstCodeUnitReference

inlinenoexcept

Retrieve the last code unit at the end of the string.

Returns

A reference to the back code unit or NULLOPT if the string is empty.

Definition at line 396 of file static_string.hpp.

References iox2::bb::StaticString< N >::empty(), iox2::bb::NULLOPT, and iox2::bb::StaticString< N >::size().

element_at()

template<uint64_t N>

auto iox2::bb::StaticString< N >::ConstAccessorCodeUnits::element_at ( SizeType  index ) const -> OptionalConstCodeUnitReference

inlinenoexcept

Retrieve the single code unit at index.

Returns

A reference to the code unit or NULLOPT if the index is out of bounds.

Definition at line 376 of file static_string.hpp.

References iox2::bb::NULLOPT.

front_element()

template<uint64_t N>

auto iox2::bb::StaticString< N >::ConstAccessorCodeUnits::front_element ( ) const -> OptionalConstCodeUnitReference

inlinenoexcept

Retrieve the first code unit at the beginning of the string.

Returns

A reference to the front code unit or NULLOPT if the string is empty.

Definition at line 386 of file static_string.hpp.

References iox2::bb::StaticString< N >::empty(), and iox2::bb::NULLOPT.

operator=() [1/2]

template<uint64_t N>

auto iox2::bb::StaticString< N >::ConstAccessorCodeUnits::operator= ( ConstAccessorCodeUnits &&  ) -> ConstAccessorCodeUnits &=delete

delete

operator=() [2/2]

template<uint64_t N>

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

delete

Friends And Related Symbol Documentation

bb::detail::is_valid_path_to_directory

template<uint64_t N>

auto bb::detail::is_valid_path_to_directory ( const bb::StaticString< N > &  name ) -> bool

friend

bb::detail::is_valid_path_to_file

template<uint64_t N>

auto bb::detail::is_valid_path_to_file ( const bb::StaticString< N > &  name ) -> bool

friend

StaticString

template<uint64_t N>

friend class StaticString

friend

Definition at line 293 of file static_string.hpp.

---

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

• iox2/bb/static_string.hpp