Bind

case class Bind[-T >: Untyped] extends NamedDefTree[T] with PatternTree[T]

name @ body

trait PatternTree[T]
class NamedDefTree[T]
trait WithEndMarker[T]
trait DefTree[T]
class NameTree[T]
class DenotingTree[T]
class Tree[T]
trait Showable
trait Container
trait Cloneable
trait Product
trait Equals
trait SrcPos
class Object
trait Matchable
class Any

Type members

Types

type ThisTree[-T >: Untyped] = Bind[T]

The type constructor at the root of the tree

The type constructor at the root of the tree

Value members

Concrete methods

override def isTerm: Boolean

Does this tree represent a term?

Does this tree represent a term?

Definition Classes
override def isType: Boolean

Does this tree represent a type?

Does this tree represent a type?

Definition Classes
override def nameSpan(using Context): Span

The position of the name defined by this definition. This is a point position if the definition is synthetic, or a range position if the definition comes from source. It might also be that the definition does not have a position (for instance when synthesized by a calling chain from viewExists), in that case the return position is NoSpan. Overridden in Bind

The position of the name defined by this definition. This is a point position if the definition is synthetic, or a range position if the definition comes from source. It might also be that the definition does not have a position (for instance when synthesized by a calling chain from viewExists), in that case the return position is NoSpan. Overridden in Bind

Definition Classes

Inherited methods

final def allAttachments: List[(Key[_], Any)]

The list of all keys and values attached to this container.

The list of all keys and values attached to this container.

Inherited from:
LinkSource
final def attachment[V](key: Key[V]): V

The attachment corresponding to key.

The attachment corresponding to key.

Throws:
NoSuchElementException

if no attachment with key exists

Inherited from:
LinkSource
final def attachmentOrElse[V](key: Key[V], default: V): V

The attachment corresponding to key, or default if no attachment with key exists.

The attachment corresponding to key, or default if no attachment with key exists.

Inherited from:
LinkSource
def checkPos(nonOverlapping: Boolean)(using Context): Unit

Check that all positioned items in this tree satisfy the following conditions:

Check that all positioned items in this tree satisfy the following conditions:

  • Parent spans contain child spans
  • If item is a non-empty tree, it has a position
Inherited from:
Positioned
def cloneIn(src: SourceFile): Bind[T]

Clone this node but assign it a fresh id which marks it as a node in file.

Clone this node but assign it a fresh id which marks it as a node in file.

Inherited from:
Positioned
Inherited from:
Positioned
override def denot(using Context): Denotation

The denotation referred to by this tree. Defined for DenotingTrees and ProxyTrees, NoDenotation for other kinds of trees

The denotation referred to by this tree. Defined for DenotingTrees and ProxyTrees, NoDenotation for other kinds of trees

Definition Classes
Inherited from:
DenotingTree
final def dropEndMarker(): Bind[T]
Inherited from:
WithEndMarker
def endPos(using ctx: Context): SourcePosition
Inherited from:
SrcPos
final def endSpan(using Context): Span
Inherited from:
WithEndMarker
def envelope(src: SourceFile, startSpan: Span): Span

The union of startSpan and the spans of all positioned children that have the same source as this node, except that Inlined nodes only consider their call child.

The union of startSpan and the spans of all positioned children that have the same source as this node, except that Inlined nodes only consider their call child.

Side effect: Any descendants without spans have but with the same source as this node have their span set to the end position of the envelope of all children to the left, or, if that one does not exist, to the start position of the envelope of all children to the right.

Inherited from:
Positioned
override def equals(that: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

  • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
  • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Value parameters:
that

the object to compare against this object for equality.

Returns:

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
Tree -> Equals -> Any
Inherited from:
Tree
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

Inherited from:
Showable
def focus(using ctx: Context): SourcePosition
Inherited from:
SrcPos
def foreachInThicket(op: Tree[T] => Unit): Unit

If this is a thicket, perform op on each of its trees otherwise, perform op ion tree itself.

If this is a thicket, perform op on each of its trees otherwise, perform op ion tree itself.

Inherited from:
Tree
final def getAttachment[V](key: Key[V]): Option[V]

Optionally get attachment corresponding to key

Optionally get attachment corresponding to key

Inherited from:
LinkSource
final def hasAttachment[V](key: Key[V]): Boolean

Does an attachment corresponding to key exist?

Does an attachment corresponding to key exist?

Inherited from:
LinkSource
final def hasType: Boolean

Does the tree have its type field set? Note: this operation is not referentially transparent, because it can observe the withType modifications. Should be used only in special circumstances (we need it for printing trees with optional type info).

Does the tree have its type field set? Note: this operation is not referentially transparent, because it can observe the withType modifications. Should be used only in special circumstances (we need it for printing trees with optional type info).

Inherited from:
Tree
override def hashCode(): Int

Calculate a hash code value for the object.

Calculate a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

Returns:

the hash code value for this object.

Definition Classes
Tree -> Any
Inherited from:
Tree
override def isDef: Boolean

Does this tree define a new symbol that is not defined elsewhere?

Does this tree define a new symbol that is not defined elsewhere?

Definition Classes
Inherited from:
DefTree

Is this tree either the empty tree or the empty ValDef or an empty type ident?

Is this tree either the empty tree or the empty ValDef or an empty type ident?

Inherited from:
Tree
override def isPattern: Boolean

Is this a legal part of a pattern which is not at the same time a term?

Is this a legal part of a pattern which is not at the same time a term?

Definition Classes
Inherited from:
PatternTree
def line(using ctx: Context): Int
Inherited from:
SrcPos

The source position of the name defined by this definition. This is a point position if the definition is synthetic, or a range position if the definition comes from source.

The source position of the name defined by this definition. This is a point position if the definition is synthetic, or a range position if the definition comes from source.

Inherited from:
NamedDefTree
Inherited from:
DefTree
inline def orElse[U >: Untyped <: T](inline that: Tree[U]): Tree[U]

if this tree is the empty tree, the alternative, else this tree

if this tree is the empty tree, the alternative, else this tree

Inherited from:
Tree
Inherited from:
Product
final def pushAttachment[V](key: Key[V], value: V)(using ctx: Context): Unit
Inherited from:
Container
final def putAttachment[V](key: Key[V], value: V): Option[V]

Add attachment with given key and value.

Add attachment with given key and value.

Returns:

Optionally, the old attachment with given key if one existed before. The new attachment is added at the position of the old one, or at the end if no attachment with same key existed.

Inherited from:
LinkSource
Inherited from:
Container
final def removeAttachment[V](key: Key[V]): Option[V]

Remove attachment with given key, if it exists.

Remove attachment with given key, if it exists.

Returns:

Optionally, the removed attachment with given key if one existed before.

Inherited from:
LinkSource
def sameTree(that: Tree[_]): Boolean
Inherited from:
Tree
def setMods(mods: Modifiers): Unit

Destructively update modifiers. To be used with care.

Destructively update modifiers. To be used with care.

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

The string representation of this showable element.

The string representation of this showable element.

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).

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.

Inherited from:
Showable
Inherited from:
Positioned
Inherited from:
Positioned
def span: Span

The span part of the item's position

The span part of the item's position

Inherited from:
Positioned
def span_=(span: Span): Unit
Inherited from:
Positioned
protected def srcName(using Context): Name

The name in source code that represents this construct, and is the name that the user must write to create a valid end marker. e.g. a constructor definition is terminated in the source code by end this, so it's srcName should return this.

The name in source code that represents this construct, and is the name that the user must write to create a valid end marker. e.g. a constructor definition is terminated in the source code by end this, so it's srcName should return this.

Inherited from:
NamedDefTree
final def srcPos: SrcPos

This positioned item, widened to SrcPos. Used to make clear we only need the position, typically for error reporting.

This positioned item, widened to SrcPos. Used to make clear we only need the position, typically for error reporting.

Inherited from:
Positioned
Inherited from:
SrcPos
final def symbol(using Context): Symbol

Shorthand for denot.symbol.

Shorthand for denot.symbol.

Inherited from:
Tree
def toList: List[Tree[T]]

Convert tree to a list. Gives a singleton list, except for thickets which return their element trees.

Convert tree to a list. Gives a singleton list, except for thickets which return their element trees.

Inherited from:
Tree
override def toText(printer: Printer): Text

The text representation of this showable element. This normally dispatches to a pattern matching method in Printers.

The text representation of this showable element. This normally dispatches to a pattern matching method in Printers.

Definition Classes
Inherited from:
Tree
final def tpe: T

The type of the tree. In case of an untyped tree, an UnAssignedTypeException is thrown. (Overridden by empty trees)

The type of the tree. In case of an untyped tree, an UnAssignedTypeException is thrown. (Overridden by empty trees)

Inherited from:
Tree

The number of nodes in this tree

The number of nodes in this tree

Inherited from:
Tree
final def typeOpt: Type
Inherited from:
Tree

A unique identifier in case -Yshow-tree-ids, or -Ydebug-tree-with-id is set, -1 otherwise.

A unique identifier in case -Yshow-tree-ids, or -Ydebug-tree-with-id is set, -1 otherwise.

Inherited from:
Positioned
Inherited from:
DefTree
Inherited from:
DefTree
def withAttachment[V](key: Key[V], value: V): Bind[T]
Inherited from:
Container
final def withAttachmentsFrom(container: Container): Bind[T]

Copy the sticky attachments from container to this container.

Copy the sticky attachments from container to this container.

Inherited from:
Container
final def withEndMarker(copyFrom: WithEndMarker[_]): Bind[T]
Inherited from:
WithEndMarker
final def withEndMarker(): Bind[T]
Inherited from:
WithEndMarker
Inherited from:
DefTree
Inherited from:
DefTree
def withSpan(span: Span): Bind[T]

A positioned item like this one with given span. If the positioned item is source-derived, a clone is returned. If the positioned item is synthetic, the position is updated destructively and the item itself is returned.

A positioned item like this one with given span. If the positioned item is source-derived, a clone is returned. If the positioned item is synthetic, the position is updated destructively and the item itself is returned.

Inherited from:
Positioned
def withType(tpe: Type)(using Context): Bind[Type]

Return a typed tree that's isomorphic to this tree, but has given type. (Overridden by empty trees)

Return a typed tree that's isomorphic to this tree, but has given type. (Overridden by empty trees)

Inherited from:
Tree
Inherited from:
Tree

Inherited fields

protected var myTpe: T
Inherited from:
Tree