scala3-compiler-bootstrapped
DocsAPI
Generated with
Copyright (c) 2002-2026, LAMP/EPFL
Copyright (c) 2002-2026, LAMP/EPFL
scala3-compiler-bootstrapped/dotty.tools/dotty.tools.dotc/dotty.tools.dotc.cc/RetainingAnnotation

RetainingAnnotation

dotty.tools.dotc.cc.RetainingAnnotation
class RetainingAnnotation(tpe: Type) extends CompactAnnotation

A class for annotations @retains, @retainsByName and @retainsCap

Attributes

Graph
Supertypes
class Annotation
trait Showable
class Object
trait Matchable
class Any
Show all

Members list

Value members

Constructors

def this(cls: ClassSymbol, args: Type*)(using Context)

Concrete methods

def isStrict(using Context): Boolean
override def mapWith(tm: TypeMap)(using Context): Annotation

Normally, applies a type map to all tree nodes of this annotation, but can be overridden. Returns EmptyAnnotation if type type map produces a range type, since ranges cannot be types of trees.

Normally, applies a type map to all tree nodes of this annotation, but can be overridden. Returns EmptyAnnotation if type type map produces a range type, since ranges cannot be types of trees.

Attributes

Definition Classes
def retainedType(using Context): Type

Inherited methods

def appliesToModule: Boolean

Attributes

Inherited from:
Annotation
def argument(i: Int)(using Context): Option[Tree]

Attributes

Inherited from:
Annotation
override def argumentConstant(i: Int)(using Context): Option[Constant]

Attributes

Definition Classes
Inherited from:
CompactAnnotation
def argumentConstantString(i: Int)(using Context): Option[String]

Attributes

Inherited from:
Annotation
def argumentType(i: Int)(using Context): Type

Attributes

Inherited from:
CompactAnnotation
override def argumentTypes(using Context): List[Type]

All type arguments of this annotation in a single flat list

All type arguments of this annotation in a single flat list

Attributes

Definition Classes
Inherited from:
CompactAnnotation
override def arguments(using Context): List[Tree]

All term arguments of this annotation in a single flat list

All term arguments of this annotation in a single flat list

Attributes

Definition Classes
Inherited from:
CompactAnnotation
def derivedAnnotation(tp: Type)(using Context): Annotation

Attributes

Inherited from:
CompactAnnotation
override def derivedAnnotation(tree: Tree)(using Context): Annotation

Attributes

Definition Classes
Inherited from:
CompactAnnotation
def ensureCompleted(using Context): Unit

Attributes

Inherited from:
Annotation
override def eql(that: Annotation): Boolean

Attributes

Definition Classes
Inherited from:
CompactAnnotation
def fallbackToText(printer: Printer): Text

A fallback text representation, if the pattern matching in Printers does not have a case for this showable element

A fallback text representation, if the pattern matching in Printers does not have a case for this showable element

Attributes

Inherited from:
Showable
def hasOneOfMetaAnnotation(metaSyms: Set[Symbol], orNoneOf: Set[Symbol] = ...)(using Context): Boolean

Attributes

Inherited from:
Annotation
def hasSymbol(sym: Symbol)(using Context): Boolean

Attributes

Inherited from:
Annotation
override def hash: Int

Operations for hash-consing, can be overridden

Operations for hash-consing, can be overridden

Attributes

Definition Classes
Inherited from:
CompactAnnotation
def isEvaluated: Boolean

The tree evaluation has finished.

The tree evaluation has finished.

Attributes

Inherited from:
Annotation
def isEvaluating: Boolean

The tree evaluation is in progress.

The tree evaluation is in progress.

Attributes

Inherited from:
Annotation
def matches(cls: Symbol)(using Context): Boolean

Attributes

Inherited from:
Annotation
def oldTree(using Context): Tree

Attributes

Inherited from:
CompactAnnotation
override def refersToParamOf(tl: TermLambda)(using Context): Boolean

Does this annotation refer to a parameter of tl?

Does this annotation refer to a parameter of tl?

Attributes

Definition Classes
Inherited from:
CompactAnnotation
def sameAnnotation(that: Annotation)(using Context): Boolean

Attributes

Inherited from:
Annotation
def show(using Context): String

The string representation of this showable element.

The string representation of this showable element.

Attributes

Inherited from:
Showable
def showIndented(margin: Int)(using Context): String

The string representation with each line after the first one indented by the given given margin (in spaces).

The string representation with each line after the first one indented by the given given margin (in spaces).

Attributes

Inherited from:
Showable
def showSummary(depth: Int = ...)(using Context): String

The summarized string representation of this showable element. Recursion depth is limited to some smallish value. Default is Config.summarizeDepth.

The summarized string representation of this showable element. Recursion depth is limited to some smallish value. Default is Config.summarizeDepth.

Attributes

Inherited from:
Showable
override def symbol(using Context): Symbol

Attributes

Definition Classes
Inherited from:
CompactAnnotation
def toText(printer: Printer): Text

A string representation of the annotation. Overridden in BodyAnnotation.

A string representation of the annotation. Overridden in BodyAnnotation.

Attributes

Inherited from:
Annotation
def tree(using Context): Tree

Attributes

Inherited from:
CompactAnnotation
Generated with
Copyright (c) 2002-2026, LAMP/EPFL
Copyright (c) 2002-2026, LAMP/EPFL