avail/avail.persistence.cache.record/NamesIndex/Usage

Usage

data class Usage(val usageType: NamesIndex.UsageType, val phraseIndex: Int)

An indication of where a name is used in the file, suitable for presenting in an itemized list.

Constructors

Link copied to clipboard
constructor(binaryStream: DataInputStream)

Reconstruct a Usage from a stream. The data was put there by the write method.

constructor(usageType: NamesIndex.UsageType, phraseIndex: Int)

Properties

Link copied to clipboard
val phraseIndex: Int

An index into the canonically ordered PhraseNodes in the PhrasePathRecord for this module compilation. That PhraseNode is enough information to identify a region of the module to highlight or select to identify the usage of the name.

Link copied to clipboard
val usageType: NamesIndex.UsageType

The UsageType that indicates how the name is being used.

Functions

Link copied to clipboard
fun write(binaryStream: DataOutputStream)

Serialize the receiver onto the given DataOutputStream, in a form suitable for reconstruction via the Usage constructor taking a DataInputStream.