Scala Reflection Library2.12.21 < Back
 

# Packages

-  package root
  Definition Classes
    root
-  package scala
  Definition Classes
    root
-  package reflect
  Definition Classes
    scala
-  package api

  EXPERIMENTAL

  EXPERIMENTAL

  The Scala Reflection API (located in scala-reflect.jar).

  In Scala 2.10.0, the Scala Reflection API and its implementation have an "experimental" status. This means that the API and the docs are not complete and can be changed in binary- and source-incompatible manner in 2.10.1. This also means that the implementation has some known issues.

  The following types are the backbone of the Scala Reflection API, and serve as a good starting point for information about Scala Reflection:

  - scala.reflect.api.Symbols
  - scala.reflect.api.Types
  - scala.reflect.api.Mirrors
  - scala.reflect.api.Universe

  For more information about Scala Reflection, see the Reflection Guide

  Definition Classes
    reflect
-  trait Trees extends AnyRef

  EXPERIMENTAL

  EXPERIMENTAL

  This trait defines the node types used in Scala abstract syntax trees (AST) and operations on them.

  Trees are the basis for Scala's abstract syntax that is used to represent programs. They are also called abstract syntax trees and commonly abbreviated as ASTs.

  In Scala reflection, APIs that produce or use `Tree`s are:

  - Annotations which use trees to represent their arguments, exposed in Annotation.scalaArgs.
  - reify, a special method on scala.reflect.api.Universe that takes an expression and returns an AST which represents the expression.
  - Macros and runtime compilation with toolboxes which both use trees as their program representation medium.

  Trees are immutable, except for three fields pos, symbol, and tpe, which are assigned when a tree is typechecked to attribute it with the information gathered by the typechecker.

  ##### Examples

  The following creates an AST representing a literal 5 in Scala source code:

      Literal(Constant(5))

  The following creates an AST representing `print("Hello World")`:

      Apply(Select(Select(This(TypeName("scala")), TermName("Predef")), TermName("print")), List(Literal(Constant("Hello World"))))

  The following creates an AST from a literal 5, and then uses `showRaw` to print it in a readable format.

      import scala.reflect.runtime.universe.{ reify, showRaw }
      print( showRaw( reify{5}.tree ) )` // prints Literal(Constant(5))

  For more information about `Tree`s, see the Reflection Guide: Symbols, Trees, Types.

  Definition Classes
    api
- Alternative
- AlternativeApi
- AlternativeExtractor
- Annotated
- AnnotatedApi
- AnnotatedExtractor
- AppliedTypeTree
- AppliedTypeTreeApi
- AppliedTypeTreeExtractor
- Apply
- ApplyApi
- ApplyExtractor
- Assign
- AssignApi
- AssignExtractor
- AssignOrNamedArg
- AssignOrNamedArgApi
- AssignOrNamedArgExtractor
- Bind
- BindApi
- BindExtractor
- Block
- BlockApi
- BlockExtractor
- CaseDef
- CaseDefApi
- CaseDefExtractor
- ClassDef
- ClassDefApi
- ClassDefExtractor
- CompoundTypeTree
- CompoundTypeTreeApi
- CompoundTypeTreeExtractor
- DefDef
- DefDefApi
- DefDefExtractor
- DefTree
- DefTreeApi
- ExistentialTypeTree
- ExistentialTypeTreeApi
- ExistentialTypeTreeExtractor
- Function
- FunctionApi
- FunctionExtractor
- GenericApply
- GenericApplyApi
- Ident
- IdentApi
- IdentExtractor
- If
- IfApi
- IfExtractor
- ImplDef
- ImplDefApi
- Import
- ImportApi
- ImportExtractor
- ImportSelector
- ImportSelectorApi
- ImportSelectorExtractor
- LabelDef
- LabelDefApi
- LabelDefExtractor
- Literal
- LiteralApi
- LiteralExtractor
- Match
- MatchApi
- MatchExtractor
- MemberDef
- MemberDefApi
- Modifiers
- ModifiersApi
- ModifiersExtractor
- ModuleDef
- ModuleDefApi
- ModuleDefExtractor
- NameTree
- NameTreeApi
- New
- NewApi
- NewExtractor
- PackageDef
- PackageDefApi
- PackageDefExtractor
- RefTree
- RefTreeApi
- RefTreeExtractor
- Return
- ReturnApi
- ReturnExtractor
- Select
- SelectApi
- SelectExtractor
- SelectFromTypeTree
- SelectFromTypeTreeApi
- SelectFromTypeTreeExtractor
- SingletonTypeTree
- SingletonTypeTreeApi
- SingletonTypeTreeExtractor
- Star
- StarApi
- StarExtractor
- Super
- SuperApi
- SuperExtractor
- SymTree
- SymTreeApi
- Template
- TemplateApi
- TemplateExtractor
- TermTree
- TermTreeApi
- This
- ThisApi
- ThisExtractor
- Throw
- ThrowApi
- ThrowExtractor
- Transformer
- Traverser
- Tree
- TreeApi
- TreeCopier
- TreeCopierOps
- Try
- TryApi
- TryExtractor
- TypTree
- TypTreeApi
- TypeApply
- TypeApplyApi
- TypeApplyExtractor
- TypeBoundsTree
- TypeBoundsTreeApi
- TypeBoundsTreeExtractor
- TypeDef
- TypeDefApi
- TypeDefExtractor
- TypeTree
- TypeTreeApi
- TypeTreeExtractor
- Typed
- TypedApi
- TypedExtractor
- UnApply
- UnApplyApi
- UnApplyExtractor
- ValDef
- ValDefApi
- ValDefExtractor
- ValOrDefDef
- ValOrDefDefApi

c

scala.reflect.api.Trees

# BindExtractor 

###

#### abstract class BindExtractor extends AnyRef

An extractor class to create and pattern match with syntax `Bind(name, body)`. This AST node corresponds to the following Scala code:

pat*

Source
  Trees.scala

Linear Supertypes
AnyRef, Any
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. BindExtractor
2. AnyRef
3. Any

Implicitly

1. by any2stringadd
2. by StringFormat
3. by Ensuring
4. by ArrowAssoc

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Instance Constructors

1.  new BindExtractor()

### Abstract Value Members

1.  abstract def apply(name: Universe.Name, body: Universe.Tree): Universe.Bind
2.  abstract def unapply(bind: Universe.Bind): Option[(Universe.Name, Universe.Tree)]

### Concrete Value Members

1.  final def !=(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
2.  final def ##(): Int
   Definition Classes
     AnyRef → Any
3.  def +(other: String): String
   Implicit
     This member is added by an implicit conversion from Universe.BindExtractor to any2stringadd[Universe.BindExtractor] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
4.  def ->[B](y: B): (Universe.BindExtractor, B)
   Implicit
     This member is added by an implicit conversion from Universe.BindExtractor to ArrowAssoc[Universe.BindExtractor] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @inline()
5.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
6.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
7.  def clone(): AnyRef
   Attributes
     protected[lang]
   Definition Classes
     AnyRef
   Annotations
     @throws( ... ) @native()
8.  def ensuring(cond: (Universe.BindExtractor) ⇒ Boolean, msg: ⇒ Any): Universe.BindExtractor
   Implicit
     This member is added by an implicit conversion from Universe.BindExtractor to Ensuring[Universe.BindExtractor] performed by method Ensuring in scala.Predef.
   Definition Classes
     Ensuring
9.  def ensuring(cond: (Universe.BindExtractor) ⇒ Boolean): Universe.BindExtractor
   Implicit
     This member is added by an implicit conversion from Universe.BindExtractor to Ensuring[Universe.BindExtractor] performed by method Ensuring in scala.Predef.
   Definition Classes
     Ensuring
10.  def ensuring(cond: Boolean, msg: ⇒ Any): Universe.BindExtractor
    Implicit
      This member is added by an implicit conversion from Universe.BindExtractor to Ensuring[Universe.BindExtractor] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
11.  def ensuring(cond: Boolean): Universe.BindExtractor
    Implicit
      This member is added by an implicit conversion from Universe.BindExtractor to Ensuring[Universe.BindExtractor] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
12.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
13.  def equals(arg0: Any): Boolean
    Definition Classes
      AnyRef → Any
14.  def finalize(): Unit
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( classOf[java.lang.Throwable] )
15.  final def getClass(): Class[_]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
16.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
17.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
18.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
19.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
20.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
21.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
22.  def toString(): String
    Definition Classes
      AnyRef → Any
23.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
24.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
25.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... ) @native()
26.  def →[B](y: B): (Universe.BindExtractor, B)
    Implicit
      This member is added by an implicit conversion from Universe.BindExtractor to ArrowAssoc[Universe.BindExtractor] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
      ArrowAssoc

### Deprecated Value Members

1.  def formatted(fmtstr: String): String
   Implicit
     This member is added by an implicit conversion from Universe.BindExtractor to StringFormat[Universe.BindExtractor] performed by method StringFormat in scala.Predef.
   Definition Classes
     StringFormat
   Annotations
     @deprecated @inline()
   Deprecated

     (Since version 2.12.16) Use `formatString.format(value)` instead of `value.formatted(formatString)`, or use the `f""` string interpolator. In Java 15 and later, `formatted` resolves to the new method in String which has reversed parameters.

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion any2stringadd from Universe.BindExtractor to any2stringadd[Universe.BindExtractor]

### Inherited by implicit conversion StringFormat from Universe.BindExtractor to StringFormat[Universe.BindExtractor]

### Inherited by implicit conversion Ensuring from Universe.BindExtractor to Ensuring[Universe.BindExtractor]

### Inherited by implicit conversion ArrowAssoc from Universe.BindExtractor to ArrowAssoc[Universe.BindExtractor]

### Ungrouped