NonEmptyString

Companion object for class NonEmptyString.

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

Value members

Concrete methods

def apply(s: String): NonEmptyString

Constructs a new NonEmptyString given at least one element.

Constructs a new NonEmptyString given at least one element.

Value parameters:
s

the String represented by this NonEmptyString

Source:
NonEmptyString.scala
def apply(firstChar: Char, otherChars: Char*): NonEmptyString

Constructs a new NonEmptyString given at least one character.

Constructs a new NonEmptyString given at least one character.

Value parameters:
firstChar

the first character (with index 0) contained in this NonEmptyString

otherChars

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

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

Optionally construct a NonEmptyString containing the characters, if any, of a given GenSeq.

Optionally construct a NonEmptyString containing the characters, if any, of a given GenSeq.

Value parameters:
seq

the GenSeq of Char with which to construct a NonEmptyString

Returns:

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

Source:
NonEmptyString.scala
def unapplySeq(nonEmptyString: NonEmptyString): Option[Seq[String]]

Variable argument extractor for NonEmptyStrings.

Variable argument extractor for NonEmptyStrings.

Value parameters:
nonEmptyString:

the NonEmptyString containing the elements to extract

Returns:

an Seq containing this NonEmptyStrings elements, wrapped in a Some

Source:
NonEmptyString.scala

Implicits

Implicits

implicit def nonEmptyStringToGenTraversableOnceOfChar(nonEmptyString: NonEmptyString): IterableOnce[Char]

Implicit conversion from NonEmptyString to GenTraversableOnce[Char].

Implicit conversion from NonEmptyString to GenTraversableOnce[Char].

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

scala> Vector(NonEmptyString("123"), NonEmptyString("34"), NonEmptyString("5678")).flatten
res0: scala.collection.immutable.Vector[Char] = Vector('1', '2', '3', '3', '4', '5', '6', '7', '8')
Value parameters:
nonEmptyString

the NonEmptyString to convert to a GenTraversableOnce[Char]

Returns:

a GenTraversableOnce[Char] containing the elements, in order, of this NonEmptyString

Source:
NonEmptyString.scala
implicit def nonEmptyStringToPartialFunction(nonEmptyString: NonEmptyString): PartialFunction[Int, Char]