Extractor

An 'extractor' can be a case class or an unapply or unapplySeq method. Decoding what it is that they extract takes place before we arrive here, so that this class can concentrate only on the relationship between patterns and types.

In a case class, the class is the unextracted type and the fixed and repeated types are derived from its constructor parameters.

In an unapply, this is reversed: the parameter to the unapply is the unextracted type, and the other types are derived based on the return type of the unapply method.

In other words, this case class and unapply are encoded the same:

case class Foo(x: Int, y: Int, zs: Char*) def unapplySeq(x: Foo): Option[(Int, Int, Seq[Char])]

Both are Extractor(Foo, Int :: Int :: Nil, Repeated(Seq[Char], Char, Char*))

whole: The type in its unextracted form
fixed: The non-sequence types which are extracted
repeated: The sequence type which is extracted

Linear Supertypes

Serializable, java.io.Serializable, Product, Equals, AnyRef, Any

Type Hierarchy Learn more about scaladoc diagrams

Instance Constructors

new Extractor(whole: Type, fixed: List[Type], repeated: Repeated)

whole
The type in its unextracted form
fixed
The non-sequence types which are extracted
repeated
The sequence type which is extracted

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 Extractor to StringAdd[Extractor] performed by method StringAdd in scala.Predef.
Definition Classes
StringAdd
def ->[B](y: B): (Extractor, B)

Implicit information
This member is added by an implicit conversion from Extractor to ArrowAssoc[Extractor] 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 allTypes: collection.immutable.List[Type]
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

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

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

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

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

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

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
val fixed: List[Type]

The non-sequence types which are extracted
def formatted(fmtstr: String): String

Implicit information
This member is added by an implicit conversion from Extractor to StringFormat[Extractor] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hasSeq: Boolean
def isErroneous: Boolean
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 offeringString: String
def productArity: Int

Definition Classes
Extractor → Product
val repeated: Repeated

The sequence type which is extracted
def sequenceType: Type
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
Extractor → AnyRef → Any
def varargsTypes: collection.immutable.List[Type]
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( ... )
val whole: Type

The type in its unextracted form
def →[B](y: B): (Extractor, B)

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

final case class Extractor(whole: Type, fixed: List[Type], repeated: Repeated) extends Product with Serializable

Instance Constructors

new Extractor(whole: Type, fixed: List[Type], repeated: Repeated)

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

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

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

def allTypes: collection.immutable.List[Type]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def elementType: Type

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

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

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

def ensuring(cond: Boolean): Extractor

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

val fixed: List[Type]

def formatted(fmtstr: String): String

final def getClass(): Class[_]

def hasSeq: Boolean

def isErroneous: Boolean

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def offeringString: String

def productArity: Int

val repeated: Repeated

def sequenceType: Type

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

def toString(): String

def varargsTypes: collection.immutable.List[Type]

final def wait(): Unit

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

final def wait(arg0: Long): Unit

val whole: Type

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

Inherited from Serializable

Inherited from java.io.Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped