Scalactic is brought to you by:

object NonEmptyList

Companion object for class NonEmptyList.

Source
NonEmptyList.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. NonEmptyList
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

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

    T

    the type of the element contained in the new NonEmptyList

    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

  2. def from[T](seq: GenSeq[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.

    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

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

    nonEmptyList

    the NonEmptyList to convert to a List

    returns

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

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

    Variable argument extractor for NonEmptyLists.

    Variable argument extractor for NonEmptyLists.

    returns

    an Seq containing this NonEmptyLists elements, wrapped in a Some