Public Types | Public Member Functions | Private Member Functions | Private Attributes | Static Private Attributes | Friends | List of all members
Catch::StringRef Class Reference

#include <catch.hpp>

Public Types

using size_type = std::size_t
 

Public Member Functions

auto c_str () const -> char const *
 
auto currentData () const noexcept-> char const *
 
auto empty () const noexcept-> bool
 
auto numberOfCharacters () const noexcept-> size_type
 
 operator std::string () const
 
auto operator!= (StringRef const &other) const noexcept-> bool
 
auto operator= (StringRef const &other) noexcept-> StringRef &
 
auto operator== (StringRef const &other) const noexcept-> bool
 
auto operator[] (size_type index) const noexcept-> char
 
auto size () const noexcept-> size_type
 
 StringRef () noexcept
 
 StringRef (StringRef const &other) noexcept
 
 StringRef (StringRef &&other) noexcept
 
 StringRef (char const *rawChars) noexcept
 
 StringRef (char const *rawChars, size_type size) noexcept
 
 StringRef (std::string const &stdString) noexcept
 
auto substr (size_type start, size_type size) const noexcept-> StringRef
 
void swap (StringRef &other) noexcept
 
 ~StringRef () noexcept
 

Private Member Functions

auto isOwned () const noexcept-> bool
 
auto isSubstring () const noexcept-> bool
 
void takeOwnership ()
 

Private Attributes

char * m_data = nullptr
 
size_type m_size
 
char const * m_start
 

Static Private Attributes

static constexpr char const *const s_empty = ""
 

Friends

struct StringRefTestAccess
 

Detailed Description

A non-owning string class (similar to the forthcoming std::string_view) Note that, because a StringRef may be a substring of another string, it may not be null terminated. c_str() must return a null terminated string, however, and so the StringRef will internally take ownership (taking a copy), if necessary. In theory this ownership is not externally visible - but it does mean (substring) StringRefs should not be shared between threads.

Definition at line 491 of file catch.hpp.

Member Typedef Documentation

using Catch::StringRef::size_type = std::size_t

Definition at line 493 of file catch.hpp.

Constructor & Destructor Documentation

Catch::StringRef::StringRef ( )
inlinenoexcept

Definition at line 508 of file catch.hpp.

Catch::StringRef::StringRef ( StringRef const &  other)
inlinenoexcept

Definition at line 512 of file catch.hpp.

Catch::StringRef::StringRef ( StringRef &&  other)
inlinenoexcept

Definition at line 517 of file catch.hpp.

Catch::StringRef::StringRef ( char const *  rawChars)
noexcept
Catch::StringRef::StringRef ( char const *  rawChars,
size_type  size 
)
inlinenoexcept

Definition at line 527 of file catch.hpp.

Catch::StringRef::StringRef ( std::string const &  stdString)
inlinenoexcept

Definition at line 532 of file catch.hpp.

Catch::StringRef::~StringRef ( )
inlinenoexcept

Definition at line 537 of file catch.hpp.

Member Function Documentation

auto Catch::StringRef::c_str ( ) const -> char const *
auto Catch::StringRef::currentData ( ) const -> char const *
noexcept
auto Catch::StringRef::empty ( ) const -> bool
inlinenoexcept

Definition at line 560 of file catch.hpp.

auto Catch::StringRef::isOwned ( ) const -> bool
privatenoexcept
auto Catch::StringRef::isSubstring ( ) const -> bool
privatenoexcept
auto Catch::StringRef::numberOfCharacters ( ) const -> size_type
noexcept
Catch::StringRef::operator std::string ( ) const
auto Catch::StringRef::operator!= ( StringRef const &  other) const -> bool
noexcept
auto Catch::StringRef::operator= ( StringRef const &  other) -> StringRef&
inlinenoexcept

Definition at line 541 of file catch.hpp.

auto Catch::StringRef::operator== ( StringRef const &  other) const -> bool
noexcept
auto Catch::StringRef::operator[] ( size_type  index) const -> char
noexcept
auto Catch::StringRef::size ( ) const -> size_type
inlinenoexcept

Definition at line 563 of file catch.hpp.

auto Catch::StringRef::substr ( size_type  start,
size_type  size 
) const -> StringRef
noexcept
void Catch::StringRef::swap ( StringRef other)
noexcept
void Catch::StringRef::takeOwnership ( )
private

Friends And Related Function Documentation

friend struct StringRefTestAccess
friend

Definition at line 496 of file catch.hpp.

Member Data Documentation

char* Catch::StringRef::m_data = nullptr
private

Definition at line 501 of file catch.hpp.

size_type Catch::StringRef::m_size
private

Definition at line 499 of file catch.hpp.

char const* Catch::StringRef::m_start
private

Definition at line 498 of file catch.hpp.

constexpr char const* const Catch::StringRef::s_empty = ""
staticprivate

Definition at line 505 of file catch.hpp.


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


catch_ros
Author(s): Max Schwarz
autogenerated on Thu Jan 14 2021 03:32:26