Scala 3/API/scala/Product1

Product1

trait Product1[@specialized(Int, Long, Double) +T1] extends Product

Product1 is a Cartesian product of 1 component.

Product1 is a Cartesian product of 1 component.

Companion
object
trait Product
trait Equals
class Any
class (T1)

Value members

Abstract methods

def _1: T1

A projection of element 1 of this Product.

A projection of element 1 of this Product.

Returns

A projection of element 1.

Concrete methods

override def productArity: Int

The arity of this product.

The arity of this product.

Returns

1

Definition Classes
@throws(scala.Predef.classOf[scala.IndexOutOfBoundsException])
override def productElement(n: Int): Any

Returns the n-th projection of this product if 0 <= n < productArity, otherwise throws an IndexOutOfBoundsException.

Returns the n-th projection of this product if 0 <= n < productArity, otherwise throws an IndexOutOfBoundsException.

Value Params
n

number of the projection to be returned

Returns

same as ._(n+1), for example productElement(0) is the same as ._1.

Throws
IndexOutOfBoundsException

if the n is out of range(n < 0 || n >= 1).

Definition Classes

Inherited methods

def canEqual(that: Any): Boolean

A method that should be called from every well-designed equals method that is open to be overridden in a subclass.

A method that should be called from every well-designed equals method that is open to be overridden in a subclass. See Programming in Scala, Chapter 28 for discussion and design.

Value Params
that

the value being probed for possible equality

Returns

true if this instance can possibly equal that, otherwise false

Inherited from
Equals
def productElementName(n: Int): String

The name of the nth element of this product, 0-based.

The name of the nth element of this product, 0-based. In the default implementation, an empty string.

Value Params
n

the index of the element name to return

Returns

the name of the specified element

Throws
IndexOutOfBoundsException

if the n is out of range(n < 0 || n >= productArity).

Inherited from
Product
def productElementNames: Iterator[String]

An iterator over the names of all the elements of this product.

An iterator over the names of all the elements of this product.

Inherited from
Product
def productIterator: Iterator[Any]

An iterator over all the elements of this product.

An iterator over all the elements of this product.

Returns

in the default implementation, an Iterator[Any]

Inherited from
Product
def productPrefix: String

A string used in the toString methods of derived classes.

A string used in the toString methods of derived classes. Implementations may override this method to prepend a string prefix to the result of toString methods.

Returns

in the default implementation, the empty string

Inherited from
Product