Scala 3/scala.quoted/Quotes/reflectModule/SymbolMethods

SymbolMethods

given SymbolMethods

Extension methods of Symbol

Source:
Quotes.scala

Extensions

Extensions

extension (self: Symbol)
def allOverriddenSymbols: Iterator[Symbol]

Returns all symbols overridden by this symbol.

Returns all symbols overridden by this symbol.

Source:
Quotes.scala
def annotations: List[Term]

Annotations attached to this symbol

Annotations attached to this symbol

Source:
Quotes.scala
def caseFields: List[Symbol]

Fields of a case class type -- only the ones declared in primary constructor

Fields of a case class type -- only the ones declared in primary constructor

Source:
Quotes.scala
def children: List[Symbol]

Case class or case object children of a sealed trait

Case class or case object children of a sealed trait

Source:
Quotes.scala
def companionClass: Symbol

The symbol of the companion class

The symbol of the companion class

Source:
Quotes.scala
def companionModule: Symbol

The symbol of the companion module

The symbol of the companion module

Source:
Quotes.scala
def declarations: List[Symbol]

All members directly declared in the class

All members directly declared in the class

Source:
Quotes.scala
def declaredField(name: String): Symbol

Field with the given name directly declared in the class

Field with the given name directly declared in the class

Source:
Quotes.scala
def declaredFields: List[Symbol]

Fields directly declared in the class

Fields directly declared in the class

Source:
Quotes.scala
def declaredMethod(name: String): List[Symbol]

Get non-private named methods defined directly inside the class

Get non-private named methods defined directly inside the class

Source:
Quotes.scala
def declaredMethods: List[Symbol]

Get all non-private methods defined directly inside the class, excluding constructors

Get all non-private methods defined directly inside the class, excluding constructors

Source:
Quotes.scala
def declaredType(name: String): List[Symbol]

Get non-private named methods defined directly inside the class

Get non-private named methods defined directly inside the class

Source:
Quotes.scala
def declaredTypes: List[Symbol]

Get all non-private methods defined directly inside the class, excluding constructors

Get all non-private methods defined directly inside the class, excluding constructors

Source:
Quotes.scala
def docstring: Option[String]

The documentation for this symbol, if any

The documentation for this symbol, if any

Source:
Quotes.scala
def exists: Boolean

Does this symbol represent a definition?

Does this symbol represent a definition?

Source:
Quotes.scala
def fieldMember(name: String): Symbol

Get named non-private fields declared or inherited

Get named non-private fields declared or inherited

Source:
Quotes.scala
def fieldMembers: List[Symbol]

Get all non-private fields declared or inherited

Get all non-private fields declared or inherited

Source:
Quotes.scala
def flags: Flags

Flags of this symbol

Flags of this symbol

Source:
Quotes.scala
def fullName: String

The full name of this symbol up to the root package

The full name of this symbol up to the root package

Source:
Quotes.scala
def getAnnotation(annotSym: Symbol): Option[Term]

Get the annotation defined with annotSym attached to this symbol

Get the annotation defined with annotSym attached to this symbol

Source:
Quotes.scala
def hasAnnotation(annotSym: Symbol): Boolean

Is the annotation defined with annotSym attached to this symbol?

Is the annotation defined with annotSym attached to this symbol?

Source:
Quotes.scala
def isAbstractType: Boolean

Is this symbol an abstract type?

Is this symbol an abstract type?

Source:
Quotes.scala
def isAliasType: Boolean

Is this symbol an alias type?

Is this symbol an alias type?

Source:
Quotes.scala
def isAnonymousClass: Boolean

Is this symbol an anonymous class?

Is this symbol an anonymous class?

Source:
Quotes.scala
def isAnonymousFunction: Boolean

Is this symbol an anonymous function?

Is this symbol an anonymous function?

Source:
Quotes.scala
def isBind: Boolean

Is this the definition of a Bind pattern?

Is this the definition of a Bind pattern?

Source:
Quotes.scala
def isClassConstructor: Boolean

Is this the constructor of a class?

Is this the constructor of a class?

Source:
Quotes.scala
def isClassDef: Boolean

Is this the definition of a ClassDef tree?

Is this the definition of a ClassDef tree?

Source:
Quotes.scala
def isDefDef: Boolean

Is this the definition of a DefDef tree?

Is this the definition of a DefDef tree?

Source:
Quotes.scala
def isDefinedInCurrentRun: Boolean

Does this symbol come from a currently compiled source file?

Does this symbol come from a currently compiled source file?

Source:
Quotes.scala
def isLocalDummy: Boolean

Dummy val symbol that owns all statements within the initialization of the class.

Dummy val symbol that owns all statements within the initialization of the class. This may also contain local definitions such as classes defined in a locally block in the class.

Source:
Quotes.scala
def isNoSymbol: Boolean

Does this symbol represent a no definition?

Does this symbol represent a no definition?

Source:
Quotes.scala
def isPackageDef: Boolean

Is this the definition of a PackageDef tree?

Is this the definition of a PackageDef tree?

Source:
Quotes.scala
def isRefinementClass: Boolean

Is this symbol a class representing a refinement?

Is this symbol a class representing a refinement?

Source:
Quotes.scala
def isTerm: Boolean

Is this the definition of a term?

Is this the definition of a term?

Source:
Quotes.scala
def isType: Boolean

Is this the definition of a type?

Is this the definition of a type?

Source:
Quotes.scala
def isTypeDef: Boolean

Is this the definition of a TypeDef tree

Is this the definition of a TypeDef tree

Source:
Quotes.scala
def isValDef: Boolean

Is this the definition of a ValDef tree?

Is this the definition of a ValDef tree?

Source:
Quotes.scala
def maybeOwner: Symbol

Owner of this symbol.

Owner of this symbol. The owner is the symbol in which this symbol is defined. Returns NoSymbol if this symbol does not have an owner.

Source:
Quotes.scala
def memberField(name: String): Symbol

Get named non-private fields declared or inherited

Get named non-private fields declared or inherited

Source:
Quotes.scala
def memberFields: List[Symbol]

Get all non-private fields declared or inherited

Get all non-private fields declared or inherited

Source:
Quotes.scala
def memberMethod(name: String): List[Symbol]

Get named non-private methods declared or inherited

Get named non-private methods declared or inherited

Source:
Quotes.scala
def memberMethods: List[Symbol]

Get all non-private methods declared or inherited

Get all non-private methods declared or inherited

Source:
Quotes.scala
def memberType(name: String): Symbol

Type member with the given name directly declared in the class

Type member with the given name directly declared in the class

Source:
Quotes.scala
def memberTypes: List[Symbol]

Type member directly declared in the class

Type member directly declared in the class

Source:
Quotes.scala
def methodMember(name: String): List[Symbol]

Get named non-private methods declared or inherited

Get named non-private methods declared or inherited

Source:
Quotes.scala
def methodMembers: List[Symbol]

Get all non-private methods declared or inherited

Get all non-private methods declared or inherited

Source:
Quotes.scala
def moduleClass: Symbol

The class symbol of the companion module class

The class symbol of the companion module class

Source:
Quotes.scala
def name: String

The name of this symbol

The name of this symbol

Source:
Quotes.scala
def overridingSymbol(ofclazz: Symbol): Symbol

The symbol overriding this symbol in given subclass ofclazz.

The symbol overriding this symbol in given subclass ofclazz.

Value parameters:
ofclazz

is a subclass of this symbol's owner

Source:
Quotes.scala
def owner: Symbol

Owner of this symbol.

Owner of this symbol. The owner is the symbol in which this symbol is defined. Throws if this symbol does not have an owner.

Source:
Quotes.scala
def paramSymss: List[List[Symbol]]

The symbols of each type parameter list and value parameter list of this method, or Nil if this isn't a method.

The symbols of each type parameter list and value parameter list of this method, or Nil if this isn't a method.

Source:
Quotes.scala
def pos: Option[Position]

The position of this symbol

The position of this symbol

Source:
Quotes.scala
def primaryConstructor: Symbol

The primary constructor of a class or trait, noSymbol if not applicable.

The primary constructor of a class or trait, noSymbol if not applicable.

Source:
Quotes.scala
def privateWithin: Option[TypeRepr]

This symbol is private within the resulting type

This symbol is private within the resulting type

Source:
Quotes.scala
def protectedWithin: Option[TypeRepr]

This symbol is protected within the resulting type

This symbol is protected within the resulting type

Source:
Quotes.scala
def signature: Signature

Signature of this definition

Signature of this definition

Source:
Quotes.scala
def tree: Tree

Tree of this definition

Tree of this definition

If this symbol isClassDef it will return a ClassDef, if this symbol isTypeDef it will return a TypeDef, if this symbol isValDef it will return a ValDef, if this symbol isDefDef it will return a DefDef if this symbol isBind it will return a Bind, else will throw

**Warning**: avoid using this method in macros.

**Caveat**: The tree is not guaranteed to exist unless the compiler option -Yretain-trees is enabled.

**Anti-pattern**: The following code is an anti-pattern:

symbol.tree.tpe

It should be replaced by the following code:

tp.memberType(symbol)

Source:
Quotes.scala
def typeMember(name: String): Symbol

Type member with the given name directly declared in the class

Type member with the given name directly declared in the class

Source:
Quotes.scala
def typeMembers: List[Symbol]

Type member directly declared in the class

Type member directly declared in the class

Source:
Quotes.scala