Structure
ResolvedTopicReference
A reference to a piece of documentation which has been verified to exist.
struct ResolvedTopicReference
Discussion
A ResolvedTopicReference refers to some piece of documentation, such as an article or symbol. Once an UnresolvedTopicReference has been resolved to this type, it should be guaranteed that the content backing the documentation is available (i.e. there is a file on disk or data in memory ready to be recalled at any time).
Implementation Details
ResolvedTopicReference is effectively a wrapper around Foundation’s URL and, because of this, it exposes an API very similar to URL and does not allow direct modification of its properties. This immutability brings performance benefits and communicates with user’s of the API that doing something like adding a path component is a potentially expensive operation, just as it is on URL.
Important
This type has copy-on-write semantics and wraps an underlying class to store its data.
Topics
Operators
Initializers
Instance Properties
Instance Methods
Type Properties
Type Methods