Scalactic 3.2.17/org.scalactic.anyvals/NonEmptyList

NonEmptyList

object NonEmptyList

Companion object for class NonEmptyList.

Companion:
class
Source:
NonEmptyList.scala
class Object
trait Matchable
class Any

Value members

Concrete methods

def apply[T](firstElement: T, otherElements: T*): NonEmptyList[T]

Constructs a new NonEmptyList given at least one element.

Constructs a new NonEmptyList given at least one element.

Type parameters:
T

the type of the element contained in the new NonEmptyList

Value parameters:
firstElement

the first element (with index 0) contained in this NonEmptyList

otherElements

a varargs of zero or more other elements (with index 1, 2, 3, ...) contained in this NonEmptyList

Source:
NonEmptyList.scala
def from[T](seq: Seq[T]): Option[NonEmptyList[T]]

Optionally construct a NonEmptyList containing the elements, if any, of a given GenSeq.

Optionally construct a NonEmptyList containing the elements, if any, of a given GenSeq.

Value parameters:
seq

the GenSeq with which to construct a NonEmptyList

Returns:

a NonEmptyList containing the elements of the given GenSeq, if non-empty, wrapped in a Some; else None if the GenSeq is empty

Source:
NonEmptyList.scala
def unapplySeq[T](nonEmptyList: NonEmptyList[T]): Option[Seq[T]]

Variable argument extractor for NonEmptyLists.

Variable argument extractor for NonEmptyLists.

Value parameters:
nonEmptyList:

the NonEmptyList containing the elements to extract

Returns:

an Seq containing this NonEmptyLists elements, wrapped in a Some

Source:
NonEmptyList.scala

Implicits

Implicits

implicit def nonEmptyListToList[E](nonEmptyList: NonEmptyList[E]): List[E]

Implicit conversion from NonEmptyList to List.

Implicit conversion from NonEmptyList to List.

One use case for this implicit conversion is to enable GenSeq[NonEmptyList]s to be flattened. Here's an example:

scala> Vector(NonEmptyList(1, 2, 3), NonEmptyList(3, 4), NonEmptyList(5, 6, 7, 8)).flatten
res0: scala.collection.immutable.Vector[Int] = Vector(1, 2, 3, 3, 4, 5, 6, 7, 8)
Value parameters:
nonEmptyList

the NonEmptyList to convert to a List

Returns:

a List containing the elements, in order, of this NonEmptyList

Source:
NonEmptyList.scala