fmt::BasicStringRef< Char > Class Template Reference

#include <format.h>

Public Member Functions
	BasicStringRef (const Char *s, std::size_t size)
	BasicStringRef (const Char *s)
template<typename Allocator >
	BasicStringRef (const std::basic_string< Char, std::char_traits< Char >, Allocator > &s)
std::basic_string< Char >	to_string () const
const Char *	data () const
std::size_t	size () const
int	compare (BasicStringRef other) const

Private Attributes
const Char *	data_
std::size_t	size_

Friends
bool	operator== (BasicStringRef lhs, BasicStringRef rhs)
bool	operator!= (BasicStringRef lhs, BasicStringRef rhs)
bool	operator< (BasicStringRef lhs, BasicStringRef rhs)
bool	operator<= (BasicStringRef lhs, BasicStringRef rhs)
bool	operator> (BasicStringRef lhs, BasicStringRef rhs)
bool	operator>= (BasicStringRef lhs, BasicStringRef rhs)

Detailed Description

template<typename Char>
class fmt::BasicStringRef< Char >

\rst A string reference. It can be constructed from a C string or std::basic_string.

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

+---------—+----------------------—+ | Type | Definition | +============+=========================+ | StringRef | BasicStringRef<char> | +---------—+----------------------—+ | WStringRef | BasicStringRef<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(StringRef format_str, const Args & ... args);

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

Definition at line 537 of file format.h.

Constructor & Destructor Documentation

BasicStringRef() [1/3]

template<typename Char >

fmt::BasicStringRef< Char >::BasicStringRef ( const Char * s, std::size_t size )

inline

Constructs a string reference object from a C string and a size.

Definition at line 544 of file format.h.

BasicStringRef() [2/3]

template<typename Char >

fmt::BasicStringRef< Char >::BasicStringRef ( const Char * s )

inline

\rst Constructs a string reference object from a C string computing the size with std::char_traits<Char>::length. \endrst

Definition at line 552 of file format.h.

BasicStringRef() [3/3]

template<typename Char >

template<typename Allocator >

fmt::BasicStringRef< Char >::BasicStringRef ( const std::basic_string< Char, std::char_traits< Char >, Allocator > & s )

inline

\rst Constructs a string reference from a std::basic_string object. \endrst

Definition at line 561 of file format.h.

Member Function Documentation

compare()

template<typename Char >

int fmt::BasicStringRef< Char >::compare ( BasicStringRef< Char > other ) const

inline

Definition at line 601 of file format.h.

data()

template<typename Char >

const Char * fmt::BasicStringRef< Char >::data ( ) const

inline

Returns a pointer to the string data.

Definition at line 595 of file format.h.

size()

template<typename Char >

std::size_t fmt::BasicStringRef< Char >::size ( ) const

inline

Returns the string size.

Definition at line 598 of file format.h.

to_string()

template<typename Char >

std::basic_string< Char > fmt::BasicStringRef< Char >::to_string ( ) const

inline

\rst Converts a string reference to an std::string object. \endrst

Definition at line 590 of file format.h.

Friends And Related Symbol Documentation

operator!=

template<typename Char >

bool operator!= ( BasicStringRef< Char > lhs, BasicStringRef< Char > rhs )

friend

Definition at line 612 of file format.h.

operator<

template<typename Char >

bool operator< ( BasicStringRef< Char > lhs, BasicStringRef< Char > rhs )

friend

Definition at line 615 of file format.h.

operator<=

template<typename Char >

bool operator<= ( BasicStringRef< Char > lhs, BasicStringRef< Char > rhs )

friend

Definition at line 618 of file format.h.

operator==

template<typename Char >

bool operator== ( BasicStringRef< Char > lhs, BasicStringRef< Char > rhs )

friend

Definition at line 609 of file format.h.

operator>

template<typename Char >

bool operator> ( BasicStringRef< Char > lhs, BasicStringRef< Char > rhs )

friend

Definition at line 621 of file format.h.

operator>=

template<typename Char >

bool operator>= ( BasicStringRef< Char > lhs, BasicStringRef< Char > rhs )

friend

Definition at line 624 of file format.h.

Member Data Documentation

data_

template<typename Char >

const Char* fmt::BasicStringRef< Char >::data_

private

Definition at line 539 of file format.h.

size_

template<typename Char >

std::size_t fmt::BasicStringRef< Char >::size_

private

Definition at line 540 of file format.h.

---

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

• C:/Users/lachl/Downloads/ArkServerAPI_NEW/ASA/AsaApi/AsaApi/Core/Public/Logger/spdlog/fmt/bundled/format.h