zio-prelude-docs
API
Generated with
zio-prelude-docs/zio.prelude/NonEmptyList

NonEmptyList

zio.prelude.NonEmptyList
See theNonEmptyList companion object
sealed trait NonEmptyList[+A]

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.

Attributes

Companion
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Cons[A]
class Single[A]
Self type

Members list

Value members

Abstract methods

def head: A

Returns the head of this NonEmptyList.

Returns the head of this NonEmptyList.

Attributes

Concrete methods

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

Concatenates this NonEmptyList with the specified NonEmptyList.

Concatenates this NonEmptyList with the specified NonEmptyList.

Attributes

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

Concatenates this NonEmptyList with the specified Iterable.

Concatenates this NonEmptyList with the specified Iterable.

Attributes

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

Prepends the specified value to this NonEmptyList.

Prepends the specified value to this NonEmptyList.

Attributes

final def contains[A1 >: A](a: A1)(implicit A: Equal[A1]): Boolean

Returns whether this NonEmptyList contains the specified element.

Returns whether this NonEmptyList contains the specified element.

Attributes

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.

Attributes

final def count(f: A => Boolean): Int

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

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

Attributes

final def distinct: NonEmptyList[A]

Removes duplicate elements from this NonEmptyList.

Removes duplicate elements from this NonEmptyList.

Attributes

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.

Attributes

final def dropRight(n: Int): List[A]

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

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

Attributes

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.

Attributes

final override 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.

Attributes

Definition Classes
Any
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.

Attributes

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.

Attributes

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.

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

Attributes

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

Flattens a NonEmptyList of NonEmptyList values into a single NonEmptyList.

Flattens a NonEmptyList of NonEmptyList values into a single NonEmptyList.

Attributes

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

Attributes

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.

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

Attributes

final def forEach[F[_] : Covariant, B](f: A => F[B]): F[NonEmptyList[B]]

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

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

Attributes

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.

Attributes

final override def hashCode: Int

Returns the hashCode of this NonEmptyList.

Returns the hashCode of this NonEmptyList.

Attributes

Definition Classes
Any
final def length: Int

Returns the length of this NonEmptyList.

Returns the length of this NonEmptyList.

Attributes

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.

Attributes

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

Effectfully maps the elements of this NonEmptyList.

Effectfully maps the elements of this NonEmptyList.

Attributes

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.

Effectfully maps the elements of this NonEmptyList in parallel.

Attributes

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

Returns the maximum element in this NonEmptyList.

Returns the maximum element in this NonEmptyList.

Attributes

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.

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.

Attributes

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

Returns the minimum element in this NonEmptyList.

Returns the minimum element in this NonEmptyList.

Attributes

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.

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.

Attributes

final def mkString: String

Renders the elements of this NonEmptyList as a String.

Renders the elements of this NonEmptyList as a String.

Attributes

final def mkString(sep: String): String

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

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

Attributes

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.

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

Attributes

final def peel: (A, List[A])

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

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

Attributes

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

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

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

Attributes

final def product[A1 >: A](implicit A: Associative[subtypeF.Type[A1]]): A1

Returns the product of the elements of this NonEmptyList.

Returns the product of the elements of this NonEmptyList.

Attributes

final def reduce[A1 >: A](implicit A: Associative[A1]): A1

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

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

Attributes

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

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.

Attributes

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.

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

Attributes

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.

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.

Attributes

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.

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.

Attributes

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

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

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

Attributes

final def reverse: NonEmptyList[A]

Reverses the order of elements in this NonEmptyList.

Reverses the order of elements in this NonEmptyList.

Attributes

final def sum[A1 >: A](implicit A: Associative[subtypeF.Type[A1]]): A1

Returns the sum of the elements of this NonEmptyList.

Returns the sum of the elements of this NonEmptyList.

Attributes

final def tailNonEmpty: Option[NonEmptyList[A]]

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

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

Attributes

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.

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

Attributes

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

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

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

Attributes

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

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

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

Attributes

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

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

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

Attributes

final def toCons[A1 >: A]: ::[A1]

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

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

Attributes

final def toNonEmptyChunk: NonEmptyChunk[A]

Converts this NonEmptyList to a NonEmptyChunk.

Converts this NonEmptyList to a NonEmptyChunk.

Attributes

final override def toString: String

Renders this NonEmptyList as a String.

Renders this NonEmptyList as a String.

Attributes

Definition Classes
Any
final def zip[B](that: NonEmptyList[B]): NonEmptyList[(A, B)]

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.

Attributes

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.

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.

Attributes

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

Annotates each element of this NonEmptyList with its index.

Annotates each element of this NonEmptyList with its index.

Attributes

Generated with