WPILibC++ 2024.3.2
basic_cstring_view< Char > Class Template Reference

\rst A reference to a null-terminated string. More...

#include </home/runner/work/allwpilib/allwpilib/wpiutil/src/main/native/thirdparty/fmtlib/include/fmt/os.h>

Public Member Functions

 basic_cstring_view (const Char *s)
 Constructs a string reference object from a C string. More...
 
 basic_cstring_view (const std::basic_string< Char > &s)
 \rst Constructs a string reference from an std::string object. More...
 
const Char * c_str () const
 Returns the pointer to a C string. More...
 

Detailed Description

template<typename Char>
class basic_cstring_view< Char >

\rst A reference to a null-terminated string.

It can be constructed from a C string or std::string.

You can use one of the following type aliases for common character types:

+------------—+--------------------------—+ | Type | Definition | +===============+=============================+ | cstring_view | basic_cstring_view<char> | +------------—+--------------------------—+ | wcstring_view | basic_cstring_view<wchar_t> | +------------—+--------------------------—+

This class is most useful as a parameter type to allow passing different types of strings to a function, for example::

template <typename... Args> std::string format(cstring_view format_str, const Args & ... args);

format("{}", 42); format(std::string("{}"), 42); \endrst

Constructor & Destructor Documentation

◆ basic_cstring_view() [1/2]

template<typename Char >
basic_cstring_view< Char >::basic_cstring_view ( const Char *  s)
inline

Constructs a string reference object from a C string.

◆ basic_cstring_view() [2/2]

template<typename Char >
basic_cstring_view< Char >::basic_cstring_view ( const std::basic_string< Char > &  s)
inline

\rst Constructs a string reference from an std::string object.

\endrst

Member Function Documentation

◆ c_str()

template<typename Char >
const Char * basic_cstring_view< Char >::c_str ( ) const
inline

Returns the pointer to a C string.


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