Packages

sealed trait NonEmptyList[+A] extends NonEmptySeq[A, NonEmptyList, List]

A NonEmptyList[A] is a list of one or more values of type A. Unlike a List, a NonEmptyList is guaranteed to contain at least one element. This additional structure allows some operations to be defined on NonEmptyList that are not safe on List, such as head and reduceAll.

For interoperability with Scala's collection library an implicit conversion is provided from NonEmptyList to the :: case of List. Operations that cannot preserve the guarantee that the resulting collection must have at least one element will return a List instead.

Self Type
NonEmptyList[A]
Linear Supertypes
NonEmptySeq[A, NonEmptyList, List], NonEmptyOps[A, NonEmptyList, List], AnyRef, Any
Known Subclasses
Cons, Single
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. NonEmptyList
  2. NonEmptySeq
  3. NonEmptyOps
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def head: A

    Returns the head of this NonEmptyList.

    Returns the head of this NonEmptyList.

    Definition Classes
    NonEmptyList → NonEmptyOps

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ++[A1 >: A](that: Iterable[A1]): NonEmptyList[A1]

    Concatenates this NonEmptyList with the specified Iterable.

  4. final def ++[A1 >: A](that: NonEmptyList[A1]): NonEmptyList[A1]

    Concatenates this NonEmptyList with the specified NonEmptyList.

  5. final def ::[A1 >: A](a: A1): NonEmptyList[A1]

    Prepends the specified value to this NonEmptyList.

  6. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  7. def appended[B >: A](elem: B): NonEmptyList[B]

    Prepends the specified value to this NonEmptyList.

    Prepends the specified value to this NonEmptyList.

    Definition Classes
    NonEmptyList → NonEmptySeq
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  10. def collect[B](pf: PartialFunction[A, B]): List[B]

    Collects all elements of this NonEmptyList that match the specified partial function.

    Collects all elements of this NonEmptyList that match the specified partial function.

    Definition Classes
    NonEmptyList → NonEmptyOps
  11. def collectFirst[B](pf: PartialFunction[A, B]): Option[B]

    Selects the first element of this NonEmptyList that matches the specified partial function.

    Selects the first element of this NonEmptyList that matches the specified partial function.

    Definition Classes
    NonEmptyList → NonEmptySeq
  12. final def contains[A1 >: A](a: A1)(implicit A: Equal[A1]): Boolean

    Returns whether this NonEmptyList contains the specified element.

  13. final def corresponds[B](that: NonEmptyList[B])(f: (A, B) => Boolean): Boolean

    Determines whether this NonEmptyList and the specified NonEmptyList have the same length and every pair of corresponding elements of this NonEmptyList and the specified NonEmptyList satisfy the specified predicate.

    Determines whether this NonEmptyList and the specified NonEmptyList have the same length and every pair of corresponding elements of this NonEmptyList and the specified NonEmptyList satisfy the specified predicate.

    Annotations
    @tailrec()
  14. final def count(f: (A) => Boolean): Int

    Returns the number of elements in this NonEmptyList that satisfy the specified predicate.

  15. final def distinct: NonEmptyList[A]

    Removes duplicate elements from this NonEmptyList.

    Removes duplicate elements from this NonEmptyList.

    Definition Classes
    NonEmptyList → NonEmptySeq
  16. final def drop(n: Int): List[A]

    Drops the first n elements from this NonEmptyList returning a List.

    Drops the first n elements from this NonEmptyList returning a List.

    Annotations
    @tailrec()
  17. final def dropRight(n: Int): List[A]

    Drops the last n elements from this NonEmptyList returning a List.

  18. final def dropWhile(f: (A) => Boolean): List[A]

    Drops elements from the start of this NonEmptyList that satisfy the specified predicate returning a List.

    Drops elements from the start of this NonEmptyList that satisfy the specified predicate returning a List.

    Annotations
    @tailrec()
  19. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def equals(that: Any): Boolean

    Returns whether this NonEmptyList and the specified NonEmptyList are equal to each other.

    Returns whether this NonEmptyList and the specified NonEmptyList are equal to each other.

    Definition Classes
    NonEmptyList → AnyRef → Any
  21. final def exists(f: (A) => Boolean): Boolean

    Returns whether an element exists in this NonEmptyList satisfying the specified predicate.

    Returns whether an element exists in this NonEmptyList satisfying the specified predicate.

    Definition Classes
    NonEmptyList → NonEmptyOps
    Annotations
    @tailrec()
  22. def filter(p: (A) => Boolean): List[A]

    Filters elements of this NonEmptyList that satisfy the specified predicate.

    Filters elements of this NonEmptyList that satisfy the specified predicate.

    Definition Classes
    NonEmptyList → NonEmptyOps
  23. def filterNot(p: (A) => Boolean): List[A]

    Filters elements of this NonEmptyList that satisfy the specified predicate.

    Filters elements of this NonEmptyList that satisfy the specified predicate.

    Definition Classes
    NonEmptyList → NonEmptyOps
  24. final def find(f: (A) => Boolean): Option[A]

    Returns the first element in this NonEmptyList satisfying the specified predicate or None otherwise.

    Returns the first element in this NonEmptyList satisfying the specified predicate or None otherwise.

    Definition Classes
    NonEmptyList → NonEmptyOps
    Annotations
    @tailrec()
  25. final def flatMap[B](f: (A) => NonEmptyList[B]): NonEmptyList[B]

    Transforms each element of this NonEmptyList to a NonEmptyList and combines them into a single NonEmptyList.

  26. final def flatten[B](implicit ev: <:<[A, NonEmptyList[B]]): NonEmptyList[B]

    Flattens a NonEmptyList of NonEmptyList values into a single NonEmptyList.

  27. final def foldLeft[B](z: B)(f: (B, A) => B): B

    Folds over the elements of this NonEmptyList from left to right using the specified initial value and combining function

    Folds over the elements of this NonEmptyList from left to right using the specified initial value and combining function

    Definition Classes
    NonEmptyList → NonEmptyOps
    Annotations
    @tailrec()
  28. final def foldRight[B](z: B)(op: (A, B) => B): B

    Folds over the elements of this NonEmptyList from right to left using the specified initial value and combining function.

  29. final def forEach[F[+_], B](f: (A) => F[B])(implicit arg0: AssociativeBoth[F], arg1: Covariant[F]): F[NonEmptyList[B]]

    Transforms each element of this NonEmptyList with the specified effectual function.

  30. final def forall(f: (A) => Boolean): Boolean

    Returns whether all elements of this NonEmptyList satisfy the specified predicate.

    Returns whether all elements of this NonEmptyList satisfy the specified predicate.

    Definition Classes
    NonEmptyList → NonEmptyOps
    Annotations
    @tailrec()
  31. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  32. def grouped(size: Int): Iterator[NonEmptyList[A]]

    Groups elements of this NonEmptyList into an Iterator of NonEmptyLists of the specified size.

    Groups elements of this NonEmptyList into an Iterator of NonEmptyLists of the specified size. The last group may be smaller than the specified size.

    Definition Classes
    NonEmptyList → NonEmptyOps
  33. final def hashCode(): Int

    Returns the hashCode of this NonEmptyList.

    Returns the hashCode of this NonEmptyList.

    Definition Classes
    NonEmptyList → AnyRef → Any
  34. def init: List[A]
    Definition Classes
    NonEmptyList → NonEmptyOps
  35. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  36. def iterator: Iterator[A]

    Iterates over the elements of this NonEmptyList.

    Iterates over the elements of this NonEmptyList.

    Definition Classes
    NonEmptyList → NonEmptyOps
  37. def last: A

    Returns the last element in this NonEmptyList.

    Returns the last element in this NonEmptyList.

    Definition Classes
    NonEmptyList → NonEmptyOps
  38. final def length: Int

    Returns the length of this NonEmptyList.

  39. final def map[B](f: (A) => B): NonEmptyList[B]

    Transforms the elements of this NonEmptyList with the specified function.

    Transforms the elements of this NonEmptyList with the specified function.

    Definition Classes
    NonEmptyList → NonEmptyOps
  40. final def mapZIO[R, E, B](f: (A) => ZIO[R, E, B]): ZIO[R, E, NonEmptyList[B]]

    Effectfully maps the elements of this NonEmptyList.

  41. final def mapZIOPar[R, E, B](f: (A) => ZIO[R, E, B]): ZIO[R, E, NonEmptyList[B]]

    Effectfully maps the elements of this NonEmptyList in parallel.

  42. final def max(implicit A: Ord[A]): A

    Returns the maximum element in this NonEmptyList.

  43. final def maxBy[B](f: (A) => B)(implicit B: Ord[B]): A

    Returns the maximum element in this NonEmptyList using the specified function to map values of type A to values of type B that an ordering is defined on.

  44. final def min(implicit A: Ord[A]): A

    Returns the minimum element in this NonEmptyList.

  45. final def minBy[B](f: (A) => B)(implicit B: Ord[B]): A

    Returns the minimum element in this NonEmptyList using the specified function to map values of type A to values of type B that an ordering is defined on.

  46. final def mkString(start: String, sep: String, end: String): String

    Renders the elements of this NonEmptyList as a String using the specified separator and start and end values.

  47. final def mkString(sep: String): String

    Renders the elements of this NonEmptyList as a String using the specified separator.

  48. final def mkString: String

    Renders the elements of this NonEmptyList as a String.

  49. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  50. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  51. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  52. final def peel: (A, List[A])

    Decomposes the NonEmptyList into an element and a (possibly empty) List

  53. final def peelNonEmpty: (A, Option[NonEmptyList[A]])

    Returns an element of this NonEmptyList and the remainder or None, if the remainder is empty.

  54. def prepended[B >: A](elem: B): NonEmptyList[B]

    Prepends the specified value to this NonEmptyList.

    Prepends the specified value to this NonEmptyList.

    Definition Classes
    NonEmptyList → NonEmptySeq
  55. final def product[A1 >: A](implicit A: Associative[Prod[A1]]): A1

    Returns the product of the elements of this NonEmptyList.

  56. def reduce[B >: A](op: (B, B) => B): B

    Reduces the elements of this NonEmptyList from left to right using the specified function.

    Reduces the elements of this NonEmptyList from left to right using the specified function.

    Definition Classes
    NonEmptyList → NonEmptyOps
  57. final def reduce[A1 >: A](implicit A: Associative[A1]): A1

    Reduces the elements of this NonEmptyList using the specified associative operator.

  58. final def reduceLeft[A1 >: A](f: (A1, A1) => A1): A1

    Reduces the elements of this NonEmptyList from left to right using the specified function.

  59. final def reduceMap[B](f: (A) => B)(implicit B: Associative[B]): B

    Maps each element of this NonEmptyList to a type B that has an associative operation then combines them all with the associative operation.

  60. final def reduceMapLeft[B](map: (A) => B)(reduce: (B, A) => B): B

    Reduces the elements of this NonEmptyList from left to right using the function map to transform the first value to the type B and then the function reduceAll to combine the B value with each other A value.

  61. final def reduceMapRight[B](map: (A) => B)(reduce: (A, B) => B): B

    Reduces the elements of this NonEmptyList from right to left using the function map to transform the first value to the type B and then the function reduceAll to combine the B value with each other A value.

  62. final def reduceRight[A1 >: A](f: (A1, A1) => A1): A1

    Reduces the elements of this NonEmptyList from right to left using the specified function.

  63. final def reverse: NonEmptyList[A]

    Reverses the order of elements in this NonEmptyList.

    Reverses the order of elements in this NonEmptyList.

    Definition Classes
    NonEmptyList → NonEmptySeq
  64. def size: Int
    Definition Classes
    NonEmptyOps
  65. def sortBy[B](f: (A) => B)(implicit ord: scala.Ordering[B]): NonEmptyList[A]
    Definition Classes
    NonEmptyList → NonEmptySeq
  66. def sorted[B >: A](implicit ord: scala.Ordering[B]): NonEmptyList[B]
    Definition Classes
    NonEmptyList → NonEmptySeq
  67. final def sum[A1 >: A](implicit A: Associative[Sum[A1]]): A1

    Returns the sum of the elements of this NonEmptyList.

  68. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  69. def tail: List[A]
    Definition Classes
    NonEmptyList → NonEmptyOps
  70. final def tailNonEmpty: Option[NonEmptyList[A]]

    Returns the tail of this NonEmptyList if it exists or None otherwise.

  71. final def tails: NonEmptyList[NonEmptyList[A]]

    Returns a new NonEmptyList composed of this NonEmptyList followed by each of its tails, ending with a singleton NonEmptyList.

  72. final def take(n: Int): List[A]

    Takes the first n elements from this NonEmptyList returning a List.

  73. final def takeRight(n: Int): List[A]

    Takes the last n elements from this NonEmptyList returning a List.

  74. final def takeWhile(f: (A) => Boolean): List[A]

    Takes elements from the start of this NonEmptyList that satisfy the specified predicate returning a List.

  75. def toArray[B >: A](implicit arg0: ClassTag[B]): Array[B]
    Definition Classes
    NonEmptyList → NonEmptyOps
  76. final def toCons[A1 >: A]: ::[A1]

    Converts this NonEmptyList to the :: case of a List.

  77. def toIterable: Iterable[A]
    Definition Classes
    NonEmptyList → NonEmptyOps
  78. def toList: List[A]
    Definition Classes
    NonEmptyList → NonEmptyOps
  79. final def toNonEmptyChunk: NonEmptyChunk[A]

    Converts this NonEmptyList to a NonEmptyChunk.

  80. final def toString(): String

    Renders this NonEmptyList as a String.

    Renders this NonEmptyList as a String.

    Definition Classes
    NonEmptyList → AnyRef → Any
  81. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  82. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  83. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  84. def zip[B](that: NonEmptyList[B])(implicit zippable: Zippable[A, B]): NonEmptyList[Out]

    Zips this NonEmptyList together with the specified NonEmptyList, returning a new NonEmptyList with a length equal to the minimum of the two and elements combined pairwise.

    Zips this NonEmptyList together with the specified NonEmptyList, returning a new NonEmptyList with a length equal to the minimum of the two and elements combined pairwise.

    Definition Classes
    NonEmptyList → NonEmptyOps
  85. final def zipWith[B, C](that: NonEmptyList[B])(f: (A, B) => C): NonEmptyList[C]

    Zips this NonEmptyList together with the specified NonEmptyList, returning a new NonEmptyList with a length equal to the minimum of the two and elements combined pairwise using the specified function.

  86. final def zipWithIndex: NonEmptyList[(A, Int)]

    Annotates each element of this NonEmptyList with its index.

    Annotates each element of this NonEmptyList with its index.

    Definition Classes
    NonEmptyList → NonEmptyOps

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from NonEmptySeq[A, NonEmptyList, List]

Inherited from NonEmptyOps[A, NonEmptyList, List]

Inherited from AnyRef

Inherited from Any

Ungrouped