docs
API
Generated with
docs/scalus/scalus.compiler/scalus.compiler.sir/scalus.compiler.sir.lowering/scalus.compiler.sir.lowering.typegens/DataSirTypeGenerator

DataSirTypeGenerator

scalus.compiler.sir.lowering.typegens.DataSirTypeGenerator
object DataSirTypeGenerator extends SirTypeUplcConvertingGenerator

Type generator for the builtin Data type.

Data is a special Plutus type that can represent arbitrary structured data. It has 5 constructors:

  • Constr(tag: Integer, args: List[Data])
  • Map(pairs: List[(Data, Data)])
  • List(elements: List[Data])
  • I(value: Integer)
  • B(value: ByteString)

Pattern matching on Data requires PlutusV4's Case on Data instruction.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Value members

Concrete methods

override def canBeConvertedToData(tp: SIRType)(using LoweringContext): Boolean

Attributes

Definition Classes
override def defaultDataRepresentation(tp: SIRType)(using LoweringContext): LoweredValueRepresentation

Get default representation for data representation of this type. This representation is used when converting to data instrucutres, which holds value as data.

Get default representation for data representation of this type. This representation is used when converting to data instrucutres, which holds value as data.

Attributes

Definition Classes
override def defaultRepresentation(tp: SIRType)(using LoweringContext): LoweredValueRepresentation

Get default representation. Assumed that input parameters of functions and vars and are in this representation.

Get default representation. Assumed that input parameters of functions and vars and are in this representation.

Attributes

Definition Classes
override def defaultTypeVarReperesentation(tp: SIRType)(using LoweringContext): LoweredValueRepresentation

Get default representation for type variable. This representation is used when converting to parameters of scala functions with type parameters. (Usually the same as defaultDataRepresentation, except Lambdas).

Get default representation for type variable. This representation is used when converting to parameters of scala functions with type parameters. (Usually the same as defaultDataRepresentation, except Lambdas).

Attributes

Definition Classes
override def genConstrLowered(constr: Constr, loweredArgs: List[LoweredValue], optTargetType: Option[SIRType])(using lctx: LoweringContext): LoweredValue

Generate constructor for this type — the workhorse, takes pre-lowered arguments. Implementations override this. Always called on DataDecl.tp (or a more specific case-class type for Sum→Product dispatch).

Generate constructor for this type — the workhorse, takes pre-lowered arguments. Implementations override this. Always called on DataDecl.tp (or a more specific case-class type for Sum→Product dispatch).

Value parameters

constr
  • constructor SIR node (carries name, decl, parentTypeArgs, anns, tp)
loweredArgs
  • already-lowered constructor arguments, in declaration order. Length matches constr.args.
optTargetType
  • optional target type (e.g., for Nil typing where the constr's declared tp is List[Nothing]).

Attributes

Definition Classes
override def genMatch(matchData: Match, loweredScrutinee: LoweredValue, optTargetType: Option[SIRType])(using lctx: LoweringContext): LoweredValue

Attributes

Definition Classes
override def genSelect(sel: Select, loweredScrutinee: LoweredValue)(using lctx: LoweringContext): LoweredValue

Attributes

Definition Classes
override def toRepresentation(input: LoweredValue, outputRepresentation: LoweredValueRepresentation, pos: SIRPosition)(using lctx: LoweringContext): LoweredValue

Attributes

Definition Classes
override def upcastOne(input: LoweredValue, targetType: SIRType, pos: SIRPosition)(using LoweringContext): LoweredValue

Attributes

Definition Classes

Inherited methods

final def genConstr(constr: Constr, optTargetType: Option[SIRType] = ...)(using lctx: LoweringContext): LoweredValue

Convenience entry point — pre-lowers constr.args and delegates to genConstrLowered. Use this when the caller hasn't already lowered the arguments; callers that have pre-lowered arguments (like the main lowering driver) should call genConstrLowered directly to avoid double-lowering. Marked final so all dispatch decisions live in genConstrLowered and its overrides.

Convenience entry point — pre-lowers constr.args and delegates to genConstrLowered. Use this when the caller hasn't already lowered the arguments; callers that have pre-lowered arguments (like the main lowering driver) should call genConstrLowered directly to avoid double-lowering. Marked final so all dispatch decisions live in genConstrLowered and its overrides.

Attributes

Inherited from:
SirTypeUplcGenerator
Generated with