Attachments

EXPERIMENTAL

Attachments provide a way to associate custom metadata with symbols and trees.

Along with symbol and tpe, which represent core metadata of trees, each tree carries the attachments field that can store other metadata: compiler-defined (e.g. positions) or user-defined. Same story is true for symbols, which also have extensible metadata by the virtue of the same attachments field.

Typically attachments just store a scala.reflect.api.Position, but they can be extended to encompass arbitrary payloads. Payloads are stored in type-indexed slots, which can be read with get[T] and written with update[T] and remove[T].

This API doesn't have much use in the runtime reflection API (the scala.reflect.api package), but it might be of help for macro writers, providing a way to coordinate multiple macros operating on the same code. Therefore the attachments field is only declared in trees and symbols belonging to scala.reflect.macros.Universe.

Self Type: Attachments
Source: Attachments.scala

Linear Supertypes

AnyRef, Any

Known Subclasses

Position

Type Hierarchy Learn more about scaladoc diagrams

Instance Constructors

new Attachments()

Type Members

abstract type Pos >: Null

The position type of this attachment

Abstract Value Members

abstract def pos: Pos

The underlying position
abstract def withPos(newPos: Pos): Attachments { type Pos = Attachments.this.Pos }

Creates a copy of this attachment with the position replaced by newPos

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
def +(other: String): String

Implicit information
This member is added by an implicit conversion from Attachments to StringAdd[Attachments] performed by method StringAdd in scala.Predef.
Definition Classes
StringAdd
def ->[B](y: B): (Attachments, B)

Implicit information
This member is added by an implicit conversion from Attachments to ArrowAssoc[Attachments] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
def all: Set[Any]

The underlying payload with the guarantee that no two elements have the same type.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws()
def ensuring(cond: (Attachments) ⇒ Boolean, msg: ⇒ Any): Attachments

Implicit information
This member is added by an implicit conversion from Attachments to Ensuring[Attachments] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (Attachments) ⇒ Boolean): Attachments

Implicit information
This member is added by an implicit conversion from Attachments to Ensuring[Attachments] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): Attachments

Implicit information
This member is added by an implicit conversion from Attachments to Ensuring[Attachments] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): Attachments

Implicit information
This member is added by an implicit conversion from Attachments to Ensuring[Attachments] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws()
def formatted(fmtstr: String): String

Returns string formatted according to given format string.
Returns string formatted according to given format string. Format strings are as for String.format (@see java.lang.String.format).

Implicit information
This member is added by an implicit conversion from Attachments to StringFormat[Attachments] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
def get[T](implicit arg0: ClassTag[T]): Option[T]

An underlying payload of the given class type T.
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def remove[T](implicit arg0: ClassTag[T]): Attachments { type Pos = Attachments.this.Pos }

Creates a copy of this attachment with the payload of the given class type T removed.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def update[T](attachment: T)(implicit arg0: ClassTag[T]): Attachments { type Pos = Attachments.this.Pos }

Creates a copy of this attachment with the payload slot of T added/updated with the provided value.
Creates a copy of this attachment with the payload slot of T added/updated with the provided value. Replaces an existing payload of the same type, if exists.
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws()
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws()
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws()
def →[B](y: B): (Attachments, B)

Implicit information
This member is added by an implicit conversion from Attachments to ArrowAssoc[Attachments] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

abstract class Attachments extends AnyRef

Instance Constructors

new Attachments()

Type Members

abstract type Pos >: Null

Abstract Value Members

abstract def pos: Pos

abstract def withPos(newPos: Pos): Attachments { type Pos = Attachments.this.Pos }

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (Attachments, B)

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

def all: Set[Any]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def ensuring(cond: (Attachments) ⇒ Boolean, msg: ⇒ Any): Attachments

def ensuring(cond: (Attachments) ⇒ Boolean): Attachments

def ensuring(cond: Boolean, msg: ⇒ Any): Attachments

def ensuring(cond: Boolean): Attachments

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def formatted(fmtstr: String): String

def get[T](implicit arg0: ClassTag[T]): Option[T]

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def remove[T](implicit arg0: ClassTag[T]): Attachments { type Pos = Attachments.this.Pos }

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

def update[T](attachment: T)(implicit arg0: ClassTag[T]): Attachments { type Pos = Attachments.this.Pos }

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def →[B](y: B): (Attachments, B)

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion StringAdd from Attachments to StringAdd[Attachments]

Inherited by implicit conversion StringFormat from Attachments to StringFormat[Attachments]

Inherited by implicit conversion Ensuring from Attachments to Ensuring[Attachments]

Inherited by implicit conversion ArrowAssoc from Attachments to ArrowAssoc[Attachments]

Ungrouped