mrdocs::IdentifierName

Represents an identifier

Synopsis

Declared in <mrdocs/Metadata/Name/IdentifierName.hpp>

struct IdentifierName final
    : Name

Description

This class is used to represent an identifier that could be in the corpus or not.

When the symbol is in the corpus, the id field will be set to the symbol ID of the symbol.

When the symbol is not in the corpus, the id field will be set to SymbolID::invalid.

Base Classes

NameDescription
NameRepresents a name for a named Type

Member Functions

NameDescription
IdentifierName [constructor]Default-construct an identifier with kind Identifier.
asName asName overloads
operator== Equality compares all fields.
operator<=> Three-way comparison operators

Data Members

NameDescription
Identifier The unqualified name.
Kind The kind of name this is.
Prefix The parent name info, if any.
id The SymbolID of the named symbol, if it exists.

Static Data Members

NameDescription
kind_id The variant discriminator constant of this concrete name kind.

Non-Member Functions

NameDescription
toStringConvert the name to a human-readable string.