mrdocs::SymbolID

A unique identifier for a symbol.

Synopsis

Declared in <mrdocs/Metadata/Symbol/SymbolID.hpp>

class SymbolID;

Description

This is calculated as the SHA1 digest of the USR. A USRs is a string that provides an unambiguous reference to a symbol.

Types

Name

value_type

Member Functions

Name

Description

SymbolID [constructor]

Construct a SymbolID from a null‐terminated string.

begin

Return an iterator to the first byte of the SymbolID.

data

Return the raw data for this SymbolID.

end

Return an iterator to one past the last byte of the SymbolID.

size

Return the size of the SymbolID.

operator std::string_view

Return a string view of the SymbolID.

operator bool

Return true if this is a valid SymbolID.

operator==

Compare two SymbolIDs for equality.

operator<=>

Compare two SymbolIDs with strong ordering.

Static Member Functions

Name

Description

createFromString

Construct a SymbolID by hashing a string

Static Data Members

Name

Description

global

Symbol ID of the global namespace.

invalid

Non-Member Functions

Name

Description

getParents

Return a list of the parent symbols of the specified Symbol.

toBase16Str

Convert a SymbolID to a string

Created with MrDocs