Safe DDS
eprosima::safedds::memory::container::StaticString< N > Class Template Reference

Static size string that copies a string into a fixed size array. More...

#include <StaticString.hpp>

Public Member Functions

 StaticString () noexcept
 StaticString constructor. More...
 
 StaticString (char const *const string) noexcept
 StaticString constructor. More...
 
 StaticString (const memory::IStringView &string_view) noexcept
 StaticString constructor from IStringView. More...
 
virtual ~StaticString () noexcept=default
 Virtual destructor. More...
 
 StaticString (const StaticString &) noexcept=default
 Copy allowed. More...
 
 StaticString (StaticString &&) noexcept=default
 Movement allowed. More...
 
StaticStringoperator= (const StaticString &) noexcept=default
 Copy operator allowed. More...
 
StaticStringoperator= (StaticString &&) noexcept=default
 Movement operator allowed. More...
 
uint32_t const_string_size () const noexcept override
 Retrieves the size of the string. More...
 
char const * const_string_data () const noexcept override
 Retrieves a const pointer to the string. More...
 

Additional Inherited Members

- Protected Member Functions inherited from eprosima::safedds::memory::IStringView
 ~IStringView () noexcept=default
 Protected destructor ownership defined on creation. More...
 
 IStringView () noexcept=default
 Default creation. More...
 
 IStringView (const IStringView &) noexcept=default
 Copy allowed. More...
 
 IStringView (IStringView &&) noexcept=default
 Movement allowed. More...
 
IStringViewoperator= (const IStringView &) noexcept=default
 Copy operator allowed. More...
 
IStringViewoperator= (IStringView &&) noexcept=default
 Movement operator allowed. More...
 

Detailed Description

template<uint32_t N>
class eprosima::safedds::memory::container::StaticString< N >

Static size string that copies a string into a fixed size array.

Note
StaticString construction will trigger fatal error if provided string is too long

Constructor & Destructor Documentation

◆ StaticString() [1/5]

template<uint32_t N>
eprosima::safedds::memory::container::StaticString< N >::StaticString ( )
inlinenoexcept

StaticString constructor.

◆ StaticString() [2/5]

template<uint32_t N>
eprosima::safedds::memory::container::StaticString< N >::StaticString ( char const *const  string)
inlineexplicitnoexcept

StaticString constructor.

Parameters
stringconst char* to copy.

◆ StaticString() [3/5]

template<uint32_t N>
eprosima::safedds::memory::container::StaticString< N >::StaticString ( const memory::IStringView string_view)
inlineexplicitnoexcept

StaticString constructor from IStringView.

Parameters
string_viewconst IStringView to copy.

◆ ~StaticString()

template<uint32_t N>
virtual eprosima::safedds::memory::container::StaticString< N >::~StaticString ( )
virtualdefaultnoexcept

Virtual destructor.

◆ StaticString() [4/5]

template<uint32_t N>
eprosima::safedds::memory::container::StaticString< N >::StaticString ( const StaticString< N > &  )
defaultnoexcept

Copy allowed.

◆ StaticString() [5/5]

template<uint32_t N>
eprosima::safedds::memory::container::StaticString< N >::StaticString ( StaticString< N > &&  )
defaultnoexcept

Movement allowed.

Member Function Documentation

◆ const_string_data()

template<uint32_t N>
char const* eprosima::safedds::memory::container::StaticString< N >::const_string_data ( ) const
inlineoverridevirtualnoexcept

Retrieves a const pointer to the string.

Returns
a const pointer to the string.

Implements eprosima::safedds::memory::IStringView.

◆ const_string_size()

template<uint32_t N>
uint32_t eprosima::safedds::memory::container::StaticString< N >::const_string_size ( ) const
inlineoverridevirtualnoexcept

Retrieves the size of the string.

Returns
size of the string.

Implements eprosima::safedds::memory::IStringView.

◆ operator=() [1/2]

template<uint32_t N>
StaticString& eprosima::safedds::memory::container::StaticString< N >::operator= ( const StaticString< N > &  )
defaultnoexcept

Copy operator allowed.

Returns
StaticString&.

◆ operator=() [2/2]

template<uint32_t N>
StaticString& eprosima::safedds::memory::container::StaticString< N >::operator= ( StaticString< N > &&  )
defaultnoexcept

Movement operator allowed.

Returns
StaticString&.

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