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.

Type Aliases

Name

Description

value_type

Underlying byte storage.

Member Functions

Name

Description

SymbolID [constructor]

Constructors

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 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

Sentinel ID representing the global namespace.

invalid

Sentinel ID used to represent “no symbol.”

Non-Member Functions

Name

Description

fromBase58Str

Parse the base58 string form of a SymbolID.

getParents

Return the parents of the specified symbol

toBase16Str

Convert a SymbolID to a string

toBase58Str

Convert a SymbolID to its canonical string form.

Created with MrDocs