donner::xml::XMLQualifiedNameRef Struct Reference

Reference type for XMLQualifiedName, to pass the value to APIs without needing to allocate an RcString. More...

#include "donner/base/xml/XMLQualifiedName.h"

Public Member Functions
constexpr	XMLQualifiedNameRef (const RcStringOrRef &name)
	Construct from an attribute name, assumes no namespacePrefix.
constexpr	XMLQualifiedNameRef (const char *name)
	Construct from an attribute name as a const char*, assumes no namespacePrefix.
constexpr	XMLQualifiedNameRef (std::string_view name)
	Construct from an attribute name as a std::string_view, assumes no namespacePrefix.
constexpr	XMLQualifiedNameRef (const RcStringOrRef &namespacePrefix, const RcStringOrRef &name)
	Construct from an attribute with a namespace prefix.
constexpr	XMLQualifiedNameRef (const XMLQualifiedName &attr)
	Construct from XMLQualifiedName.
	~XMLQualifiedNameRef ()=default
	Destructor.
	XMLQualifiedNameRef (XMLQualifiedNameRef &&)=default
	Move constructor.
	XMLQualifiedNameRef (const XMLQualifiedNameRef &)=default
	Copy constructor.
XMLQualifiedNameRef &	operator= (XMLQualifiedNameRef &&)=default
	Move assignment operator.
XMLQualifiedNameRef &	operator= (const XMLQualifiedNameRef &)=default
	Copy assignment operator.
std::strong_ordering	operator<=> (const XMLQualifiedNameRef &other) const
	Comparison operator.
bool	operator== (const XMLQualifiedNameRef &other) const =default
	Equality operator for gtest.
std::string	toString () const
	Convert to string operator, using XML syntax (e.g. "ns:name").
details::DeferredCssSyntaxPrinter< XMLQualifiedNameRef >	printCssSyntax () const
	When used in an ostream output stream, prints the qualified name as a CSS selector (e.g.

Public Attributes
RcStringOrRef	namespacePrefix
	The namespace prefix of the attribute, or an empty string if no namespace (default namespace).
RcStringOrRef	name
	The attribute name.

Friends
std::strong_ordering	operator<=> (const XMLQualifiedNameRef &lhs, const XMLQualifiedName &rhs)
	Friend operator for XMLQualifiedName comparison.
std::strong_ordering	operator<=> (const XMLQualifiedName &lhs, const XMLQualifiedNameRef &rhs)
	Friend operator for XMLQualifiedName comparison.
bool	operator== (const XMLQualifiedName &lhs, const XMLQualifiedNameRef &rhs)
	Friend operator for XMLQualifiedName equality for gtest.
bool	operator== (const XMLQualifiedNameRef &lhs, const XMLQualifiedName &rhs)
	Friend operator for XMLQualifiedName equality for gtest.
std::ostream &	operator<< (std::ostream &os, const XMLQualifiedNameRef &obj)
	Ostream output operator, using XML syntax (e.g. "ns:name").

Detailed Description

Reference type for XMLQualifiedName, to pass the value to APIs without needing to allocate an RcString.

Either member may be a non-owning view, so the strings it refers to must outlive this object. Use it for in-parameters, and copy into an XMLQualifiedName to keep a name. Do not cache a std::string_view of a member of a temporary XMLQualifiedNameRef: under the small-string optimization the bytes can live inside the temporary itself.

Constructor & Destructor Documentation

XMLQualifiedNameRef() [1/5]

donner::xml::XMLQualifiedNameRef::XMLQualifiedNameRef ( const RcStringOrRef & name )

inlineconstexpr

Construct from an attribute name, assumes no namespacePrefix.

Parameters

name	The attribute name.

XMLQualifiedNameRef() [2/5]

donner::xml::XMLQualifiedNameRef::XMLQualifiedNameRef ( const char * name )

inlineconstexpr

Construct from an attribute name as a const char*, assumes no namespacePrefix.

Parameters

name	The attribute name.

XMLQualifiedNameRef() [3/5]

donner::xml::XMLQualifiedNameRef::XMLQualifiedNameRef ( std::string_view name )

inlineconstexpr

Construct from an attribute name as a std::string_view, assumes no namespacePrefix.

Parameters

name	The attribute name.

XMLQualifiedNameRef() [4/5]

donner::xml::XMLQualifiedNameRef::XMLQualifiedNameRef ( const RcStringOrRef & namespacePrefix, const RcStringOrRef & name )

inlineconstexpr

Construct from an attribute with a namespace prefix.

Parameters

namespacePrefix	The namespace of the name, or empty if the name belongs to the default namespace.
name	The attribute name.

XMLQualifiedNameRef() [5/5]

donner::xml::XMLQualifiedNameRef::XMLQualifiedNameRef ( const XMLQualifiedName & attr )

inlineconstexpr

Construct from XMLQualifiedName.

Parameters

attr	Qualified name to convert.

Member Function Documentation

printCssSyntax()

details::DeferredCssSyntaxPrinter< XMLQualifiedNameRef > donner::xml::XMLQualifiedNameRef::printCssSyntax ( ) const

inline

When used in an ostream output stream, prints the qualified name as a CSS selector (e.g.

"ns|name").

Example usage:

XMLQualifiedNameRef name;
std::cout << name.printCssSyntax() << "\n";

---

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

• donner/base/xml/XMLQualifiedName.h