Scalactic 3.2.17/org.scalactic.anyvals/NonEmptyVector

NonEmptyVector

object NonEmptyVector

Companion object for class NonEmptyVector.

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

Value members

Concrete methods

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

Constructs a new NonEmptyVector given at least one element.

Constructs a new NonEmptyVector given at least one element.

Type parameters:
T

the type of the element contained in the new NonEmptyVector

Value parameters:
firstElement

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

otherElements

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

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

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

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

Value parameters:
seq

the GenSeq with which to construct a NonEmptyVector

Returns:

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

Source:
NonEmptyVector.scala
def unapplySeq[T](nonEmptyVector: NonEmptyVector[T]): Option[Seq[T]]

Variable argument extractor for NonEmptyVectors.

Variable argument extractor for NonEmptyVectors.

Value parameters:
nonEmptyVector:

the NonEmptyVector containing the elements to extract

Returns:

an Seq containing this NonEmptyVectors elements, wrapped in a Some

Source:
NonEmptyVector.scala

Implicits

Implicits

implicit def nonEmptyVectorToVector[E](nonEmptyVector: NonEmptyVector[E]): Vector[E]

Implicit conversion from NonEmptyVector to Vector.

Implicit conversion from NonEmptyVector to Vector.

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

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

the NonEmptyVector to convert to a Vector

Returns:

a Vector containing the elements, in order, of this NonEmptyVector

Source:
NonEmptyVector.scala