fmt::BasicStringRef< Char > Class Template Reference

#include <format.h>

Public Member Functions
	BasicStringRef (const Char *s, std::size_t size)
	BasicStringRef (const Char *s)
	BasicStringRef (const std::basic_string< Char > &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 >

A string reference. It can be constructed from a C string or std::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);

Constructor & Destructor Documentation

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.

: data_(s), size_(size) {}

template<typename Char>

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

inline

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

 : data_(s), size_(std::char_traits<Char>::length(s)) {}

template<typename Char>

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

inline

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

 : data_(s.c_str()), size_(s.size()) {}

Member Function Documentation

template<typename Char>

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

inline

 {
 std::size_t size = size_ < other.size_ ? size_ : other.size_;
 int result = std::char_traits<Char>::compare(data_, other.data_, size);
 if (result == 0)
 result = size_ == other.size_ ? 0 : (size_ < other.size_ ? -1 : 1);
 return result;
 }

template<typename Char>

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

inline

Returns a pointer to the string data.

{ return data_; }

Here is the caller graph for this function:

template<typename Char>

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

inline

Returns the string size.

{ return size_; }

Here is the caller graph for this function:

template<typename Char>

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

inline

Converts a string reference to an std::string object.

 {
 return std::basic_string<Char>(data_, size_);
 }

Friends And Related Function Documentation

template<typename Char>

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

friend

 {
 return lhs.compare(rhs) != 0;
 }

template<typename Char>

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

friend

 {
 return lhs.compare(rhs) < 0;
 }

template<typename Char>

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

friend

 {
 return lhs.compare(rhs) <= 0;
 }

template<typename Char>

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

friend

 {
 return lhs.compare(rhs) == 0;
 }

template<typename Char>

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

friend

 {
 return lhs.compare(rhs) > 0;
 }

template<typename Char>

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

friend

 {
 return lhs.compare(rhs) >= 0;
 }

Member Data Documentation

template<typename Char>

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

private

template<typename Char>

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

private

---

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

• dep/cppformat/cppformat/format.h