pulumirpc.codegen.hcl

Members list

Type members

Classlikes

final case class Diagnostic(severity: DiagnosticSeverity, summary: String, detail: String, subject: Option[Range], context: Option[Range], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[Diagnostic]

Diagnostic represents information to be presented to a user about an error or anomaly in parsing or evaluating configuration.

Diagnostic represents information to be presented to a user about an error or anomaly in parsing or evaluating configuration.

Value parameters

subject

Subject and Context are both source ranges relating to the diagnostic. Subject is a tight range referring to exactly the construct that is problematic, while Context is an optional broader range (which should fully contain Subject) that ought to be shown around Subject when generating isolated source-code snippets in diagnostic messages. If Context is nil, the Subject is also the Context. Some diagnostics have no source ranges at all. If Context is set then Subject should always also be set.

summary

Summary and Detail contain the English-language description of the problem. Summary is a terse description of the general problem and detail is a more elaborate, often-multi-sentence description of the problem and what might be done to solve it.

Attributes

Companion
object
Supertypes
trait Updatable[Diagnostic]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Diagnostic extends GeneratedMessageCompanion[Diagnostic]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[Diagnostic]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
Diagnostic.type
sealed abstract class DiagnosticSeverity(val value: Int) extends GeneratedEnum

DiagnosticSeverity is the severity level of a diagnostic message.

DiagnosticSeverity is the severity level of a diagnostic message.

Attributes

Companion
object
Supertypes
trait GeneratedEnum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
object DIAG_ERROR
object DIAG_INVALID
object DIAG_WARNING
trait Recognized
class Unrecognized
object DiagnosticSeverity extends GeneratedEnumCompanion[DiagnosticSeverity]

Attributes

Companion
class
Supertypes
trait Sum
trait Mirror
trait GeneratedEnumCompanion[DiagnosticSeverity]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
object HclProto extends GeneratedFileObject

Attributes

Supertypes
class GeneratedFileObject
class Object
trait Matchable
class Any
Self type
HclProto.type
final case class Pos(line: Long, column: Long, byte: Long, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[Pos]

Pos represents a single position in a source file, by addressing the start byte of a unicode character encoded in UTF-8.

Pos represents a single position in a source file, by addressing the start byte of a unicode character encoded in UTF-8.

Value parameters

byte

Byte is the byte offset into the file where the indicated character begins. This is a zero-based offset to the first byte of the first UTF-8 codepoint sequence in the character, and thus gives a position that can be resolved without awareness of Unicode characters.

column

Column is the source code column where this position points, in unicode characters, with counting starting at 1. Column counts characters as they appear visually, so for example a latin letter with a combining diacritic mark counts as one character. This is intended for rendering visual markers against source code in contexts where these diacritics would be rendered in a single character cell. Technically speaking, Column is counting grapheme clusters as used in unicode normalization.

line

Line is the source code line where this position points. Lines are counted starting at 1 and incremented for each newline character encountered.

Attributes

Companion
object
Supertypes
trait Updatable[Pos]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Pos extends GeneratedMessageCompanion[Pos]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[Pos]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
Pos.type
final case class Range(filename: String, start: Option[Pos], end: Option[Pos], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[Range]

Range represents a span of characters between two positions in a source file.

Range represents a span of characters between two positions in a source file.

Value parameters

filename

Filename is the name of the file into which this range's positions point.

start

Start and End represent the bounds of this range. Start is inclusive and End is exclusive.

Attributes

Companion
object
Supertypes
trait Updatable[Range]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Range extends GeneratedMessageCompanion[Range]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[Range]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
Range.type