[#mrdocs-SymbolID]
= xref:mrdocs.adoc[mrdocs]::SymbolID
:relfileprefix: ../
:mrdocs:

A unique identifier for a symbol.

== Synopsis

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

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
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

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/SymbolID/value_type.adoc[`value_type`] 
| Underlying byte storage.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/SymbolID/2constructor-0b.adoc[`SymbolID`]         [.small]#[constructor]#
| Constructors
| xref:mrdocs/SymbolID/begin.adoc[`begin`] 
| Return an iterator to the first byte of the SymbolID.
| xref:mrdocs/SymbolID/data.adoc[`data`] 
| Return the raw data for this SymbolID.
| xref:mrdocs/SymbolID/end.adoc[`end`] 
| Return an iterator to one past the last byte of the SymbolID.
| xref:mrdocs/SymbolID/size.adoc[`size`] 
| Return the size of the SymbolID.
| xref:mrdocs/SymbolID/2conversion-0e.adoc[`operator std::string_view`] 
| Return a string view of the SymbolID.
| xref:mrdocs/SymbolID/2conversion-0a.adoc[`operator bool`] 
| Return true if this is a valid SymbolID.
| xref:mrdocs/SymbolID/operator_eq.adoc[`operator==`] 
| Compare two SymbolIDs for equality.
| xref:mrdocs/SymbolID/operator_3way.adoc[`operator<=>`] 
| Compare two SymbolIDs with strong ordering.
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/SymbolID/createFromString.adoc[`createFromString`] 
| Construct a SymbolID by hashing a string
|===


== Static Data Members

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/SymbolID/global.adoc[`global`] 
| Sentinel ID representing the global namespace.
| xref:mrdocs/SymbolID/invalid.adoc[`invalid`] 
| Sentinel ID used to represent “no symbol.”
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/getParents-04.adoc[`getParents`]
| Return a list of the parent symbols of the specified Symbol.
| xref:mrdocs/toBase16Str.adoc[`toBase16Str`]
| Convert a SymbolID to a string
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#