fundamentals-collections
API
Generated with
fundamentals-collections/izumi.fundamentals.collections.nonempty/NonEmptyString

NonEmptyString

izumi.fundamentals.collections.nonempty.NonEmptyString
See theNonEmptyString companion object
final class NonEmptyString extends AnyVal

A non-empty list: an ordered, immutable, non-empty collection of elements with LinearSeq performance characteristics.

The purpose of NonEmptyString is to allow you to express in a type that a String is non-empty, thereby eliminating the need for (and potential exception from) a run-time check for non-emptiness. For a non-empty sequence with IndexedSeq performance, see Vector.

== Constructing NonEmptyStrings ==

You can construct a NonEmptyString by passing one or more elements to the NonEmptyString.apply factory method:

scala> NonEmptyString(1, 2, 3)
res0: org.scalactic.anyvals.NonEmptyString[Int] = NonEmptyString(1, 2, 3)

Alternatively you can cons elements onto the End singleton object, similar to making a String starting with Nil:

scala> 1 :: 2 :: 3 :: Nil
res0: String[Int] = String(1, 2, 3)

scala> 1 :: 2 :: 3 :: End
res1: org.scalactic.NonEmptyString[Int] = NonEmptyString(1, 2, 3)

Note that although Nil is a String[Nothing], End is not a NonEmptyString[Nothing], because no empty NonEmptyString exists. (A non-empty list is a series of connected links; if you have no links, you have no non-empty list.)

scala> val nil: String[Nothing] = Nil
nil: String[Nothing] = String()

scala> val nada: NonEmptyString[Nothing] = End
<console>:16: error: type mismatch;
found   : org.scalactic.anyvals.End.type
required: org.scalactic.anyvals.NonEmptyString[Nothing]
      val nada: NonEmptyString[Nothing] = End
                                        ^

== Working with NonEmptyStrings ==

NonEmptyString does not extend Scala's Seq or Traversable traits because these require that implementations may be empty. For example, if you invoke tail on a Seq that contains just one element, you'll get an empty Seq:

scala> String(1).tail
res6: String[Int] = String()

On the other hand, many useful methods exist on Seq that when invoked on a non-empty Seq are guaranteed to not result in an empty Seq. For convenience, NonEmptyString defines a method corresponding to every such Seq method. Here are some examples:

NonEmptyString(1, 2, 3).map(_ + 1)                        // Result: NonEmptyString(2, 3, 4)
NonEmptyString(1).map(_ + 1)                              // Result: NonEmptyString(2)
NonEmptyString(1, 2, 3).containsSlice(NonEmptyString(2, 3)) // Result: true
NonEmptyString(1, 2, 3).containsSlice(NonEmptyString(3, 4)) // Result: false
NonEmptyString(-1, -2, 3, 4, 5).minBy(_.abs)              // Result: -1

NonEmptyString does not currently define any methods corresponding to Seq methods that could result in an empty Seq. However, an implicit converison from NonEmptyString to String is defined in the NonEmptyString companion object that will be applied if you attempt to call one of the missing methods. As a result, you can invoke filter on an NonEmptyString, even though filter could result in an empty sequence—but the result type will be String instead of NonEmptyString:

NonEmptyString(1, 2, 3).filter(_ < 10) // Result: String(1, 2, 3)
NonEmptyString(1, 2, 3).filter(_ > 10) // Result: String()

You can use NonEmptyStrings in for expressions. The result will be an NonEmptyString unless you use a filter (an if clause). Because filters are desugared to invocations of filter, the result type will switch to a String at that point. Here are some examples:

scala> import org.scalactic.anyvals._
import org.scalactic.anyvals._

scala> for (i <- NonEmptyString(1, 2, 3)) yield i + 1
res0: org.scalactic.anyvals.NonEmptyString[Int] = NonEmptyString(2, 3, 4)

scala> for (i <- NonEmptyString(1, 2, 3) if i < 10) yield i + 1
res1: String[Int] = String(2, 3, 4)

scala> for {
    |   i <- NonEmptyString(1, 2, 3)
    |   j <- NonEmptyString('a', 'b', 'c')
    | } yield (i, j)
res3: org.scalactic.anyvals.NonEmptyString[(Int, Char)] =
       NonEmptyString((1,a), (1,b), (1,c), (2,a), (2,b), (2,c), (3,a), (3,b), (3,c))

scala> for {
    |   i <- NonEmptyString(1, 2, 3) if i < 10
    |   j <- NonEmptyString('a', 'b', 'c')
    | } yield (i, j)
res6: String[(Int, Char)] =
       String((1,a), (1,b), (1,c), (2,a), (2,b), (2,c), (3,a), (3,b), (3,c))

Attributes

Companion:
object
Graph
Supertypes
class AnyVal
trait Matchable
class Any

Members list

Concise view

Value members

Concrete methods

def ++(other: NonEmptyString): NonEmptyString

Returns a new NonEmptyString containing this NonEmptyString followed by the passed NonEmptyString.

Returns a new NonEmptyString containing this NonEmptyString followed by the passed NonEmptyString.

Attributes

other

the NonEmptyString to append

Returns:

a new NonEmptyString that contains this NonEmptyString followed by other.

def ++(other: Vector[Char]): NonEmptyString

Returns a new NonEmptyString containing this NonEmptyString followed by the characters of the passed Vector.

Returns a new NonEmptyString containing this NonEmptyString followed by the characters of the passed Vector.

Attributes

other

the Vector of Char to append

Returns:

a new NonEmptyString that contains this NonEmptyString followed by all characters of other.

def ++(other: IterableOnce[Char]): NonEmptyString

Returns a new NonEmptyString containing this NonEmptyString followed by the characters of the passed TraversableOnce.

Returns a new NonEmptyString containing this NonEmptyString followed by the characters of the passed TraversableOnce.

Attributes

other

the TraversableOnce of Char to append

Returns:

a new NonEmptyString that contains this NonEmptyString followed by all characters of other.

def +:(c: Char): NonEmptyString

Returns a new NonEmptyString with the given character prepended.

Returns a new NonEmptyString with the given character prepended.

Note that :-ending operators are right associative. A mnemonic for +: vs. :+ is: the COLon goes on the COLlection side.

Attributes

c

the character to prepend to this NonEmptyString

Returns:

a new NonEmptyString consisting of c followed by all characters of this NonEmptyString.

def :+(c: Char): NonEmptyString

Returns a new NonEmptyString with the given character appended.

Returns a new NonEmptyString with the given character appended.

Note a mnemonic for +: vs. :+ is: the COLon goes on the COLlection side.

Attributes

c

the character to append to this NonEmptyString

Returns:

a new NonEmptyString consisting of all characters of this NonEmptyString followed by the given c.

def addString(sb: StringBuilder): StringBuilder

Appends all characters of this NonEmptyString to a string builder. The written text will consist of a concatenation of the result of invoking toString on of every element of this NonEmptyString, without any separator string.

Appends all characters of this NonEmptyString to a string builder. The written text will consist of a concatenation of the result of invoking toString on of every element of this NonEmptyString, without any separator string.

Attributes

sb

the string builder to which characters will be appended

Returns:

the string builder, sb, to which elements were appended.

def addString(sb: StringBuilder, sep: String): StringBuilder

Appends all characters of this NonEmptyString to a string builder using a separator string. The written text will consist of a concatenation of the result of invoking toString on of every character of this NonEmptyString, separated by the string sep.

Appends all characters of this NonEmptyString to a string builder using a separator string. The written text will consist of a concatenation of the result of invoking toString on of every character of this NonEmptyString, separated by the string sep.

Attributes

sb

the string builder to which characters will be appended

sep

the separator string

Returns:

the string builder, sb, to which characters were appended.

def addString(sb: StringBuilder, start: String, sep: String, end: String): StringBuilder

Appends all characters of this NonEmptyString to a string builder using start, end, and separator strings. The written text will consist of a concatenation of the string start; the result of invoking toString on all characters of this NonEmptyString, separated by the string sep; and the string end

Appends all characters of this NonEmptyString to a string builder using start, end, and separator strings. The written text will consist of a concatenation of the string start; the result of invoking toString on all characters of this NonEmptyString, separated by the string sep; and the string end

Attributes

end

the ending string

sb

the string builder to which characters will be appended

sep

the separator string

start

the starting string

Returns:

the string builder, sb, to which characters were appended.

def apply(idx: Int): Char

Selects a character by its index in the NonEmptyString.

Selects a character by its index in the NonEmptyString.

Attributes

Returns:

the character of this NonEmptyString at index idx, where 0 indicates the first element.

def charAt(idx: Int): Char

Gets a character by its index in the NonEmptyString.

Gets a character by its index in the NonEmptyString.

Attributes

Returns:

the character of this NonEmptyString at index idx, where 0 indicates the first element.

def collectFirst[U](pf: PartialFunction[Char, U]): Option[U]

Finds the first character of this NonEmptyString for which the given partial function is defined, if any, and applies the partial function to it.

Finds the first character of this NonEmptyString for which the given partial function is defined, if any, and applies the partial function to it.

Attributes

pf

the partial function

Returns:

an Option containing pf applied to the first character for which it is defined, or None if the partial function was not defined for any character.

def contains(c: Char): Boolean

Indicates whether this NonEmptyString contains a given value as an character.

Indicates whether this NonEmptyString contains a given value as an character.

Attributes

c

the element to look for

Returns:

true if this NonEmptyString has an character that is equal (as determined by ==) to c, false otherwise.

def containsSlice(that: Seq[Char]): Boolean

Indicates whether this NonEmptyString contains a given Seq of characters as a slice.

Indicates whether this NonEmptyString contains a given Seq of characters as a slice.

Attributes

that

the Seq character slice to look for

Returns:

true if this NonEmptyString contains a slice with the same characters as that, otherwise false.

def containsSlice(that: Vector[Char]): Boolean

Indicates whether this NonEmptyString contains a given Vector of character as a slice.

Indicates whether this NonEmptyString contains a given Vector of character as a slice.

Attributes

that

the Vector character slice to look for

Returns:

true if this NonEmptyString contains a character slice with the same characters as that, otherwise false.

def containsSlice(that: NonEmptyString): Boolean

Indicates whether this NonEmptyString contains a given NonEmptyString as a slice.

Indicates whether this NonEmptyString contains a given NonEmptyString as a slice.

Attributes

that

the NonEmptyString slice to look for

Returns:

true if this NonEmptyString contains a slice with the same characters as that, otherwise false.

def copyToArray(arr: Array[Char]): Unit

Copies characters of this NonEmptyString to an array. Fills the given array arr with characters of this NonEmptyString. Copying will stop once either the end of the current NonEmptyString is reached, or the end of the array is reached.

Copies characters of this NonEmptyString to an array. Fills the given array arr with characters of this NonEmptyString. Copying will stop once either the end of the current NonEmptyString is reached, or the end of the array is reached.

Attributes

arr

the array to fill

def copyToArray(arr: Array[Char], start: Int): Unit

Copies characters of this NonEmptyString to an array. Fills the given array arr with characters of this NonEmptyString, beginning at index start. Copying will stop once either the end of the current NonEmptyString is reached, or the end of the array is reached.

Copies characters of this NonEmptyString to an array. Fills the given array arr with characters of this NonEmptyString, beginning at index start. Copying will stop once either the end of the current NonEmptyString is reached, or the end of the array is reached.

Attributes

arr

the array to fill

start

the starting index

def copyToArray(arr: Array[Char], start: Int, len: Int): Unit

Copies characters of this NonEmptyString to an array. Fills the given array arr with at most len characters of this NonEmptyString, beginning at index start. Copying will stop once either the end of the current NonEmptyString is reached, the end of the array is reached, or len elements have been copied.

Copies characters of this NonEmptyString to an array. Fills the given array arr with at most len characters of this NonEmptyString, beginning at index start. Copying will stop once either the end of the current NonEmptyString is reached, the end of the array is reached, or len elements have been copied.

Attributes

arr

the array to fill

len

the maximum number of elements to copy

start

the starting index

def copyToBuffer(buf: Buffer[Char]): Unit

Copies all characters of this NonEmptyString to a buffer.

Copies all characters of this NonEmptyString to a buffer.

Attributes

buf

the buffer to which characters are copied

def corresponds[B](that: Seq[B])(p: (Char, B) => Boolean): Boolean

Indicates whether every character of this NonEmptyString relates to the corresponding element of a given Seq by satisfying a given predicate.

Indicates whether every character of this NonEmptyString relates to the corresponding element of a given Seq by satisfying a given predicate.

Attributes

B

the type of the elements of that

p

the predicate, which relates elements from this NonEmptyString and the passed Seq

that

the Seq to compare for correspondence

Returns:

true if this NonEmptyString and the passed Seq have the same length and p(x, y) is true for all corresponding elements x of this NonEmptyString and y of that, otherwise false.

def corresponds[B](that: Vector[B])(p: (Char, B) => Boolean): Boolean

Indicates whether every character of this NonEmptyString relates to the corresponding element of a given Vector by satisfying a given predicate.

Indicates whether every character of this NonEmptyString relates to the corresponding element of a given Vector by satisfying a given predicate.

Attributes

B

the type of the elements of that

p

the predicate, which relates elements from this NonEmptyString and the passed Vector

that

the Vector to compare for correspondence

Returns:

true if this NonEmptyString and the passed Vector have the same length and p(x, y) is true for all corresponding elements x of this NonEmptyString and y of that, otherwise false.

def corresponds(that: NonEmptyString)(p: (Char, Char) => Boolean): Boolean

Indicates whether every character of this NonEmptyString relates to the corresponding character of a given NonEmptyString by satisfying a given predicate.

Indicates whether every character of this NonEmptyString relates to the corresponding character of a given NonEmptyString by satisfying a given predicate.

Attributes

p

the predicate, which relates elements from this and the passed NonEmptyString

that

the NonEmptyString to compare for correspondence

Returns:

true if this and the passed NonEmptyString have the same length and p(x, y) is true for all corresponding characters x of this NonEmptyString and y of that, otherwise false.

def count(p: Char => Boolean): Int

Counts the number of characters in this NonEmptyString that satisfy a predicate.

Counts the number of characters in this NonEmptyString that satisfy a predicate.

Attributes

p

the predicate used to test characters.

Returns:

the number of characters satisfying the predicate p.

def distinct: NonEmptyString

Builds a new NonEmptyString from this NonEmptyString without any duplicate characters.

Builds a new NonEmptyString from this NonEmptyString without any duplicate characters.

Attributes

Returns:

A new NonEmptyString that contains the first occurrence of every character of this NonEmptyString.

def endsWith[B](that: Seq[B]): Boolean

Indicates whether this NonEmptyString ends with the given Seq of Char.

Indicates whether this NonEmptyString ends with the given Seq of Char.

Attributes

that

the sequence to test

Returns:

true if this NonEmptyString has that as a suffix, false otherwise.

def endsWith[B](that: Vector[B]): Boolean

Indicates whether this NonEmptyString ends with the given Vector.

Indicates whether this NonEmptyString ends with the given Vector.

Attributes

that

the Vector to test

Returns:

true if this NonEmptyString has that as a suffix, false otherwise.

def endsWith(that: NonEmptyString): Boolean

Indicates whether this NonEmptyString ends with the given NonEmptyString.

Indicates whether this NonEmptyString ends with the given NonEmptyString.

Attributes

that

the NonEmptyString to test

Returns:

true if this NonEmptyString has that as a suffix, false otherwise.

def exists(p: Char => Boolean): Boolean

Indicates whether a predicate holds for at least one of the characters of this NonEmptyString.

Indicates whether a predicate holds for at least one of the characters of this NonEmptyString.

Attributes

p

the predicate used to test characters.

Returns:

true if the given predicate p holds for some of the elements of this NonEmptyString, otherwise false.

def find(p: Char => Boolean): Option[Char]

Finds the first character of this NonEmptyString that satisfies the given predicate, if any.

Finds the first character of this NonEmptyString that satisfies the given predicate, if any.

Attributes

p

the predicate used to test characters

Returns:

an Some containing the first character in this NonEmptyString that satisfies p, or None if none exists.

def flatMap(f: Char => NonEmptyString): NonEmptyString

Builds a new NonEmptyString by applying a function to all characters of this NonEmptyString and using the characters of the resulting NonEmptyStrings.

Builds a new NonEmptyString by applying a function to all characters of this NonEmptyString and using the characters of the resulting NonEmptyStrings.

Attributes

f

the function to apply to each character.

Returns:

a new NonEmptyString containing characters obtained by applying the given function f to each character of this NonEmptyString and concatenating the characters of resulting NonEmptyStrings.

def fold(z: Char)(op: (Char, Char) => Char): Char

Folds the characters of this NonEmptyString using the specified associative binary operator.

Folds the characters of this NonEmptyString using the specified associative binary operator.

The order in which operations are performed on characters is unspecified and may be nondeterministic.

Attributes

op

a binary operator that must be associative

z

a neutral character for the fold operation; may be added to the result an arbitrary number of times, and must not change the result (e.g., Nil for list concatenation, 0 for addition, or 1 for multiplication.)

Returns:

the result of applying fold operator op between all the elements and z

def foldLeft[B](z: B)(op: (B, Char) => B): B

Applies a binary operator to a start value and all characters of this NonEmptyString, going left to right.

Applies a binary operator to a start value and all characters of this NonEmptyString, going left to right.

Attributes

B

the result type of the binary operator.

op

the binary operator.

z

the start value.

Returns:

the result of inserting op between consecutive characters of this NonEmptyString, going left to right, with the start value, z, on the left:

op(...op(op(z, x_1), x_2), ..., x_n)

where x1, ..., xn are the elements of this NonEmptyString.

def foldRight[B](z: B)(op: (Char, B) => B): B

Applies a binary operator to all characters of this NonEmptyString and a start value, going right to left.

Applies a binary operator to all characters of this NonEmptyString and a start value, going right to left.

Attributes

B

the result of the binary operator

op

the binary operator

z

the start value

Returns:

the result of inserting op between consecutive characters of this NonEmptyString, going right to left, with the start value, z, on the right:

op(x_1, op(x_2, ... op(x_n, z)...))

where x1, ..., xn are the elements of this NonEmptyString.

def forall(p: Char => Boolean): Boolean

Indicates whether a predicate holds for all characters of this NonEmptyString.

Indicates whether a predicate holds for all characters of this NonEmptyString.

Attributes

p

the predicate used to test characters.

Returns:

true if the given predicate p holds for all characters of this NonEmptyString, otherwise false.

def foreach(f: Char => Unit): Unit

Applies a function f to all characters of this NonEmptyString.

Applies a function f to all characters of this NonEmptyString.

Attributes

f

the function that is applied for its side-effect to every character. The result of function f is discarded.

def groupBy[K](f: Char => K): Map[K, NonEmptyString]

Partitions this NonEmptyString into a map of NonEmptyStrings according to some discriminator function.

Partitions this NonEmptyString into a map of NonEmptyStrings according to some discriminator function.

Attributes

K

the type of keys returned by the discriminator function.

f

the discriminator function.

Returns:

A map from keys to NonEmptyStrings such that the following invariant holds:

(nonEmptyString.toString partition f)(k) = xs filter (x => f(x) == k)

That is, every key k is bound to a NonEmptyString of those elements x for which f(x) equals k.

def grouped(size: Int): Iterator[NonEmptyString]

Partitions characters into fixed size NonEmptyStrings.

Partitions characters into fixed size NonEmptyStrings.

Attributes

size

the number of characters per group

Returns:

An iterator producing NonEmptyStrings of size size, except the last will be truncated if the characters don't divide evenly.

def hasDefiniteSize: Boolean

Returns true to indicate this NonEmptyString has a definite size, since all NonEmptyStrings are strict collections.

Returns true to indicate this NonEmptyString has a definite size, since all NonEmptyStrings are strict collections.

Attributes

def head: Char

Selects the first character of this NonEmptyString.

Selects the first character of this NonEmptyString.

Attributes

Returns:

the first character of this NonEmptyString.

def indexOf(c: Char): Int

Finds index of first occurrence of some value in this NonEmptyString.

Finds index of first occurrence of some value in this NonEmptyString.

Attributes

c

the character value to search for.

Returns:

the index of the first character of this NonEmptyString that is equal (as determined by ==) to c, or -1, if none exists.

def indexOf(c: Char, from: Int): Int

Finds index of first occurrence of some value in this NonEmptyString after or at some start index.

Finds index of first occurrence of some value in this NonEmptyString after or at some start index.

Attributes

c

the character value to search for.

from

the start index

Returns:

the index >= from of the first element of this NonEmptyString that is equal (as determined by ==) to elem, or -1, if none exists.

def indexOfSlice(that: Seq[Char]): Int

Finds first index where this NonEmptyString contains a given Seq[Char] as a slice.

Finds first index where this NonEmptyString contains a given Seq[Char] as a slice.

Attributes

that

the Seq[Char] defining the slice to look for

Returns:

the first index at which the elements of this NonEmptyString starting at that index match the characters of Seq that, or -1 of no such subsequence exists.

def indexOfSlice(that: Seq[Char], from: Int): Int

Finds first index after or at a start index where this NonEmptyString contains a given Seq[Char] as a slice.

Finds first index after or at a start index where this NonEmptyString contains a given Seq[Char] as a slice.

Attributes

from

the start index

that

the Seq[Char] defining the slice to look for

Returns:

the first index >= from at which the characters of this NonEmptyString starting at that index match the characters of Seq[Char] that, or -1 of no such subsequence exists.

def indexOfSlice(that: Vector[Char]): Int

Finds first index where this NonEmptyString contains a given Vector as a slice.

Finds first index where this NonEmptyString contains a given Vector as a slice.

Attributes

that

the Vector defining the slice to look for

Returns:

the first index such that the characters of this NonEmptyString starting at this index match the characters of Vector that, or -1 of no such subsequence exists.

def indexOfSlice(that: NonEmptyString): Int

Finds first index where this NonEmptyString contains a given NonEmptyString as a slice.

Finds first index where this NonEmptyString contains a given NonEmptyString as a slice.

Attributes

that

the NonEmptyString defining the slice to look for

Returns:

the first index such that the characters of this NonEmptyString starting at this index match the characters of NonEmptyString that, or -1 of no such subsequence exists.

def indexOfSlice(that: Vector[Char], from: Int): Int

Finds first index after or at a start index where this NonEmptyString contains a given Vector as a slice.

Finds first index after or at a start index where this NonEmptyString contains a given Vector as a slice.

Attributes

from

the start index

that

the Vector defining the slice to look for

Returns:

the first index >= from such that the characters of this NonEmptyString starting at this index match the characters of Vector that, or -1 of no such subsequence exists.

def indexOfSlice(that: NonEmptyString, from: Int): Int

Finds first index after or at a start index where this NonEmptyString contains a given NonEmptyString as a slice.

Finds first index after or at a start index where this NonEmptyString contains a given NonEmptyString as a slice.

Attributes

from

the start index

that

the NonEmptyString defining the slice to look for

Returns:

the first index >= from such that the characters of this NonEmptyString starting at this index match the characters of NonEmptyString that, or -1 of no such subsequence exists.

def indexWhere(p: Char => Boolean): Int

Finds index of the first character satisfying some predicate.

Finds index of the first character satisfying some predicate.

Attributes

p

the predicate used to test characters.

Returns:

the index of the first character of this NonEmptyString that satisfies the predicate p, or -1, if none exists.

def indexWhere(p: Char => Boolean, from: Int): Int

Finds index of the first character satisfying some predicate after or at some start index.

Finds index of the first character satisfying some predicate after or at some start index.

Attributes

from

the start index

p

the predicate used to test characters.

Returns:

the index >= from of the first character of this NonEmptyString that satisfies the predicate p, or -1, if none exists.

def indices: Range

Produces the range of all indices of this NonEmptyString.

Produces the range of all indices of this NonEmptyString.

Attributes

Returns:

a Range value from 0 to one less than the length of this NonEmptyString.

def isDefinedAt(idx: Int): Boolean

Tests whether this NonEmptyString contains given index.

Tests whether this NonEmptyString contains given index.

Attributes

idx

the index to test

Returns:

true if this NonEmptyString contains an character at position idx, false otherwise.

def isEmpty: Boolean

Returns false to indicate this NonEmptyString, like all NonEmptyStrings, is non-empty.

Returns false to indicate this NonEmptyString, like all NonEmptyStrings, is non-empty.

Attributes

Returns:

false

def isTraversableAgain: Boolean

Returns true to indicate this NonEmptyString, like all NonEmptyStrings, can be traversed repeatedly.

Returns true to indicate this NonEmptyString, like all NonEmptyStrings, can be traversed repeatedly.

Attributes

Returns:

true

def iterator: Iterator[Char]

Creates and returns a new iterator over all characters contained in this NonEmptyString.

Creates and returns a new iterator over all characters contained in this NonEmptyString.

Attributes

Returns:

the new iterator

def last: Char

Selects the last character of this NonEmptyString.

Selects the last character of this NonEmptyString.

Attributes

Returns:

the last character of this NonEmptyString.

def lastIndexOf(c: Char): Int

Finds the index of the last occurrence of some value in this NonEmptyString.

Finds the index of the last occurrence of some value in this NonEmptyString.

Attributes

c

the character value to search for.

Returns:

the index of the last character of this NonEmptyString that is equal (as determined by ==) to c, or -1, if none exists.

def lastIndexOf(c: Char, end: Int): Int

Finds the index of the last occurrence of some value in this NonEmptyString before or at a given end index.

Finds the index of the last occurrence of some value in this NonEmptyString before or at a given end index.

Attributes

c

the character value to search for.

end

the end index.

Returns:

the index >= end of the last character of this NonEmptyString that is equal (as determined by ==) to elem, or -1, if none exists.

def lastIndexOfSlice(that: Seq[Char]): Int

Finds the last index where this NonEmptyString contains a given Seq as a slice.

Finds the last index where this NonEmptyString contains a given Seq as a slice.

Attributes

that

the Seq defining the slice to look for

Returns:

the last index at which the elements of this NonEmptyString starting at that index match the characters of Seq that, or -1 of no such subsequence exists.

def lastIndexOfSlice(that: Seq[Char], end: Int): Int

Finds the last index before or at a given end index where this NonEmptyString contains a given Seq as a slice.

Finds the last index before or at a given end index where this NonEmptyString contains a given Seq as a slice.

Attributes

end

the end index

that

the Seq defining the slice to look for

Returns:

the last index >= end at which the elements of this NonEmptyString starting at that index match the characters of Seq that, or -1 of no such subsequence exists.

def lastIndexOfSlice(that: Vector[Char]): Int

Finds the last index where this NonEmptyString contains a given Vector as a slice.

Finds the last index where this NonEmptyString contains a given Vector as a slice.

Attributes

that

the Vector defining the slice to look for

Returns:

the last index at which the elements of this NonEmptyString starting at that index match the characters of Vector that, or -1 of no such subsequence exists.

def lastIndexOfSlice(that: NonEmptyString): Int

Finds the last index where this NonEmptyString contains a given NonEmptyString as a slice.

Finds the last index where this NonEmptyString contains a given NonEmptyString as a slice.

Attributes

that

the NonEmptyString defining the slice to look for

Returns:

the last index at which the elements of this NonEmptyString starting at that index match the characters of NonEmptyString that, or -1 of no such subsequence exists.

def lastIndexOfSlice(that: Vector[Char], end: Int): Int

Finds the last index before or at a given end index where this NonEmptyString contains a given Vector as a slice.

Finds the last index before or at a given end index where this NonEmptyString contains a given Vector as a slice.

Attributes

end

the end index

that

the Vector defining the slice to look for

Returns:

the last index >= end at which the elements of this NonEmptyString starting at that index match the characters of Vector that, or -1 of no such subsequence exists.

def lastIndexOfSlice(that: NonEmptyString, end: Int): Int

Finds the last index before or at a given end index where this NonEmptyString contains a given NonEmptyString as a slice.

Finds the last index before or at a given end index where this NonEmptyString contains a given NonEmptyString as a slice.

Attributes

end

the end index

that

the NonEmptyString defining the slice to look for

Returns:

the last index >= end at which the characters of this NonEmptyString starting at that index match the characters of NonEmptyString that, or -1 of no such subsequence exists.

def lastIndexWhere(p: Char => Boolean): Int

Finds index of last character satisfying some predicate.

Finds index of last character satisfying some predicate.

Attributes

p

the predicate used to test characters.

Returns:

the index of the last character of this NonEmptyString that satisfies the predicate p, or -1, if none exists.

def lastIndexWhere(p: Char => Boolean, end: Int): Int

Finds index of last character satisfying some predicate before or at given end index.

Finds index of last character satisfying some predicate before or at given end index.

Attributes

end

the end index

p

the predicate used to test characters.

Returns:

the index >= end of the last character of this NonEmptyString that satisfies the predicate p, or -1, if none exists.

def length: Int

The length of this NonEmptyString.

The length of this NonEmptyString.

Attributes

Returns:

the number of characters in this NonEmptyString.

Note:

length and size yield the same result, which will be >= 1.

def lengthCompare(len: Int): Int

Compares the length of this NonEmptyString to a test value.

Compares the length of this NonEmptyString to a test value.

Attributes

len

the test value that gets compared with the length.

Returns:

a value x where

x < 0 if this.length < len
x == 0 if this.length == len
x > 0 if this.length > len
def map[U](f: Char => U): NonEmptyString

Builds a new NonEmptyString by applying a function to all characters of this NonEmptyString.

Builds a new NonEmptyString by applying a function to all characters of this NonEmptyString.

Attributes

U

the character type of the returned NonEmptyString.

f

the function to apply to each character.

Returns:

a new NonEmptyString resulting from applying the given function f to each character of this NonEmptyString and collecting the results.

def max(implicit cmp: Ordering[Char]): Char

Finds the largest character.

Finds the largest character.

Attributes

Returns:

the largest element of this NonEmptyString.

def maxBy[U](f: Char => U)(implicit cmp: Ordering[U]): Char

Finds the largest result after applying the given function to every character.

Finds the largest result after applying the given function to every character.

Attributes

Returns:

the largest result of applying the given function to every character of this NonEmptyString.

def min(implicit cmp: Ordering[Char]): Char

Finds the smallest character.

Finds the smallest character.

Attributes

Returns:

the smallest character of this NonEmptyString.

def minBy[U](f: Char => U)(implicit cmp: Ordering[U]): Char

Finds the smallest result after applying the given function to every character.

Finds the smallest result after applying the given function to every character.

Attributes

Returns:

the smallest result of applying the given function to every character of this NonEmptyString.

def mkString: String

Displays all characters of this NonEmptyString in a string.

Displays all characters of this NonEmptyString in a string.

Attributes

Returns:

a string representation of this NonEmptyString. In the resulting string, the result of invoking toString on all characters of this NonEmptyString follow each other without any separator string.

def mkString(sep: String): String

Displays all elements of this NonEmptyString in a string using a separator string.

Displays all elements of this NonEmptyString in a string using a separator string.

Attributes

sep

the separator string

Returns:

a string representation of this NonEmptyString. In the resulting string, the result of invoking toString on all elements of this NonEmptyString are separated by the string sep.

def mkString(start: String, sep: String, end: String): String

Displays all characters of this NonEmptyString in a string using start, end, and separator strings.

Displays all characters of this NonEmptyString in a string using start, end, and separator strings.

Attributes

end

the ending string.

sep

the separator string.

start

the starting string.

Returns:

a string representation of this NonEmptyString. The resulting string begins with the string start and ends with the string end. Inside, In the resulting string, the result of invoking toString on all characters of this NonEmptyString are separated by the string sep.

def nonEmpty: Boolean

Returns true to indicate this NonEmptyString, like all NonEmptyStrings, is non-empty.

Returns true to indicate this NonEmptyString, like all NonEmptyStrings, is non-empty.

Attributes

Returns:

true

def padTo(len: Int, c: Char): NonEmptyString

A copy of this NonEmptyString with an element value appended until a given target length is reached.

A copy of this NonEmptyString with an element value appended until a given target length is reached.

Attributes

c

the padding character

len

the target length

Returns:

a new NonEmptyString consisting of all characters of this NonEmptyString followed by the minimal number of occurrences of elem so that the resulting NonEmptyString has a length of at least len.

def patch(from: Int, that: NonEmptyString, replaced: Int): NonEmptyString

Produces a new NonEmptyString where a slice of characters in this NonEmptyString is replaced by another NonEmptyString

Produces a new NonEmptyString where a slice of characters in this NonEmptyString is replaced by another NonEmptyString

Attributes

from

the index of the first replaced character

replaced

the number of characters to drop in the original NonEmptyString

that

the NonEmptyString whose characters should replace a slice in this NonEmptyString

def permutations: Iterator[NonEmptyString]

Iterates over distinct permutations.

Iterates over distinct permutations.

Here's an example:

NonEmptyString("abb").permutations.toList == list(NonEmptyString("abb"), NonEmptyString("bab"), NonEmptyString("bba"))

Attributes

Returns:

an iterator that traverses the distinct permutations of this NonEmptyString.

def prefixLength(p: Char => Boolean): Int

Returns the length of the longest prefix whose characters all satisfy some predicate.

Returns the length of the longest prefix whose characters all satisfy some predicate.

Attributes

p

the predicate used to test characters.

Returns:

the length of the longest prefix of this NonEmptyString such that every characters of the segment satisfies the predicate p.

def product(implicit num: Numeric[Char]): Char

The result of multiplying all the characters of this NonEmptyString.

The result of multiplying all the characters of this NonEmptyString.

This method can be invoked for any NonEmptyString for which an implicit Numeric[T] exists.

Attributes

Returns:

the product of all elements

def reduce(op: (Char, Char) => Char): Char

Reduces the elements of this NonEmptyString using the specified associative binary operator.

Reduces the elements of this NonEmptyString using the specified associative binary operator.

The order in which operations are performed on characters is unspecified and may be nondeterministic.

Attributes

op

a binary operator that must be associative.

Returns:

the result of applying reduce operator op between all the characters of this NonEmptyString.

def reduceLeft(op: (Char, Char) => Char): Char

Applies a binary operator to all characters of this NonEmptyString, going left to right.

Applies a binary operator to all characters of this NonEmptyString, going left to right.

Attributes

op

the binary operator.

Returns:

the result of inserting op between consecutive characters of this NonEmptyString, going left to right:

op(...op(op(x_1, x_2), x_3), ..., x_n)

where x1, ..., xn are the characters of this NonEmptyString.

def reduceLeftOption(op: (Char, Char) => Char): Option[Char]

Applies a binary operator to all characters of this NonEmptyString, going left to right, returning the result in a Some.

Applies a binary operator to all characters of this NonEmptyString, going left to right, returning the result in a Some.

Attributes

op

the binary operator.

Returns:

a Some containing the result of reduceLeft(op)

def reduceOption(op: (Char, Char) => Char): Option[Char]
def reduceRight(op: (Char, Char) => Char): Char

Applies a binary operator to all characters of this NonEmptyString, going right to left.

Applies a binary operator to all characters of this NonEmptyString, going right to left.

Attributes

op

the binary operator

Returns:

the result of inserting op between consecutive characters of this NonEmptyString, going right to left:

op(x_1, op(x_2, ... op(x_{n-1}, x_n)...))

where x1, ..., xn are the elements of this NonEmptyString.

def reduceRightOption(op: (Char, Char) => Char): Option[Char]

Applies a binary operator to all elements of this NonEmptyString, going right to left, returning the result in a Some.

Applies a binary operator to all elements of this NonEmptyString, going right to left, returning the result in a Some.

Attributes

op

the binary operator

Returns:

a Some containing the result of reduceRight(op)

def reverse: NonEmptyString

Returns new NonEmptyString with characters in reverse order.

Returns new NonEmptyString with characters in reverse order.

Attributes

Returns:

a new NonEmptyString with all characters of this NonEmptyString in reversed order.

def reverseIterator: Iterator[Char]

An iterator yielding characters in reverse order.

An iterator yielding characters in reverse order.

Attributes

Returns:

an iterator yielding the characters of this NonEmptyString in reversed order

Note:

nonEmptyString.reverseIterator is the same as nonEmptyString.reverse.iterator, but might be more efficient.

def reverseMap[U](f: Char => U): Iterable[U]

Builds a new Iterable by applying a function to all characters of this NonEmptyString and collecting the results in reverse order.

Builds a new Iterable by applying a function to all characters of this NonEmptyString and collecting the results in reverse order.

Attributes

U

the element type of the returned Iterable.

f

the function to apply to each character.

Returns:

a new Iterable resulting from applying the given function f to each character of this NonEmptyString and collecting the results in reverse order.

Note:

nonEmptyString.reverseMap(f) is the same as nonEmptyString.reverse.map(f), but might be more efficient.

def sameElements(that: Iterable[Char]): Boolean

Checks if the given Iterable contains the same characters in the same order as this NonEmptyString.

Checks if the given Iterable contains the same characters in the same order as this NonEmptyString.

Attributes

that

the Iterable with which to compare

Returns:

true, if both this NonEmptyString and the given Iterable contain the same characters in the same order, false otherwise.

def sameElements(that: Vector[Char]): Boolean

Checks if the given Vector contains the same characters in the same order as this NonEmptyString.

Checks if the given Vector contains the same characters in the same order as this NonEmptyString.

Attributes

that

the Vector with which to compare

Returns:

true, if both this and the given Vector contain the same characters in the same order, false otherwise.

def sameElements(that: NonEmptyString): Boolean

Checks if the given NonEmptyString contains the same characters in the same order as this NonEmptyString.

Checks if the given NonEmptyString contains the same characters in the same order as this NonEmptyString.

Attributes

that

the NonEmptyString with which to compare

Returns:

true, if both this and the given NonEmptyString contain the same characters in the same order, false otherwise.

def scan(z: Char)(op: (Char, Char) => Char): NonEmptyString

Computes a prefix scan of the characters of this NonEmptyString.

Computes a prefix scan of the characters of this NonEmptyString.

Attributes

op

a binary operator that must be associative

z

a neutral element for the scan operation; may be added to the result an arbitrary number of times, and must not change the result (e.g., Nil for list concatenation, 0 for addition, or 1 for multiplication.)

Returns:

a new NonEmptyString containing the prefix scan of the elements in this NonEmptyString

Note:

The neutral character z may be applied more than once. Here are some examples:

NonEmptyString("123").scan(0)(_ + _) == NonEmptyString(0, 1, 3, 6)
NonEmptyString("123").scan("z")(_ + _.toString) == NonEmptyString("z", "z1", "z12", "z123")
def scanLeft[B](z: B)(op: (B, Char) => B): Iterable[B]

Produces a NonEmptyString containing cumulative results of applying the operator going left to right.

Produces a NonEmptyString containing cumulative results of applying the operator going left to right.

Here are some examples:

NonEmptyString("123").scanLeft(0)(_ + _.toString.toInt) == Vector(0, 1, 3, 6)
NonEmptyString("123").scanLeft("z")(_ + _) == Vector("z", "z1", "z12", "z123")

Attributes

B

the result type of the binary operator and type of the resulting NonEmptyString

op

the binary operator.

z

the start value.

Returns:

a new NonEmptyString containing the intermediate results of inserting op between consecutive characters of this NonEmptyString, going left to right, with the start value, z, on the left.

def scanRight[B](z: B)(op: (Char, B) => B): Iterable[B]

Produces a NonEmptyString containing cumulative results of applying the operator going right to left.

Produces a NonEmptyString containing cumulative results of applying the operator going right to left.

Here are some examples:

NonEmptyString("123").scanRight(0)(_.toString.toInt + _) == NonEmptyString(6, 5, 3, 0)
NonEmptyString("123").scanRight("z")(_ + _) == NonEmptyString("123z", "23z", "3z", "z")

Attributes

B

the result of the binary operator and type of the resulting NonEmptyString

op

the binary operator

z

the start value

Returns:

a new NonEmptyString containing the intermediate results of inserting op between consecutive characters of this NonEmptyString, going right to left, with the start value, z, on the right.

def segmentLength(p: Char => Boolean, from: Int): Int

Computes length of longest segment whose characters all satisfy some predicate.

Computes length of longest segment whose characters all satisfy some predicate.

Attributes

from

the index where the search starts.

p

the predicate used to test elements.

Returns:

the length of the longest segment of this NonEmptyString starting from index from such that every character of the segment satisfies the predicate p.

def size: Int

The size of this NonEmptyString.

The size of this NonEmptyString.

Attributes

Returns:

the number of characters in this NonEmptyString.

Note:

length and size yield the same result, which will be >= 1.

def sliding(size: Int): Iterator[NonEmptyString]

Groups characters in fixed size blocks by passing a “sliding window” over them (as opposed to partitioning them, as is done in grouped.)

Groups characters in fixed size blocks by passing a “sliding window” over them (as opposed to partitioning them, as is done in grouped.)

Attributes

size

the number of characters per group

Returns:

an iterator producing NonEmptyStrings of size size, except the last and the only element will be truncated if there are fewer characters than size.

def sliding(size: Int, step: Int): Iterator[NonEmptyString]

Groups characters in fixed size blocks by passing a “sliding window” over them (as opposed to partitioning them, as is done in grouped.), moving the sliding window by a given step each time.

Groups characters in fixed size blocks by passing a “sliding window” over them (as opposed to partitioning them, as is done in grouped.), moving the sliding window by a given step each time.

Attributes

size

the number of characters per group

step

the distance between the first characters of successive groups

Returns:

an iterator producing NonEmptyStrings of size size, except the last and the only character will be truncated if there are fewer characters than size.

def sortBy[U](f: Char => U)(implicit ord: Ordering[U]): NonEmptyString

Sorts this NonEmptyString according to the Ordering of the result of applying the given function to every character.

Sorts this NonEmptyString according to the Ordering of the result of applying the given function to every character.

Attributes

U

the target type of the transformation f, and the type where the Ordering ord is defined.

f

the transformation function mapping elements to some other domain U.

ord

the ordering assumed on domain U.

Returns:

a NonEmptyString consisting of the elements of this NonEmptyString sorted according to the Ordering where x < y if ord.lt(f(x), f(y)).

def sortWith(lt: (Char, Char) => Boolean): NonEmptyString

Sorts this NonEmptyString according to a comparison function.

Sorts this NonEmptyString according to a comparison function.

The sort is stable. That is, characters that are equal (as determined by lt) appear in the same order in the sorted NonEmptyString as in the original.

Attributes

lt

the comparison function that tests whether its first argument precedes its second argument in the desired ordering.

Returns:

a NonEmptyString consisting of the elements of this NonEmptyString sorted according to the comparison function lt.

def sorted(implicit ord: Ordering[Char]): NonEmptyString

Sorts this NonEmptyString according to an Ordering.

Sorts this NonEmptyString according to an Ordering.

The sort is stable. That is, elements that are equal (as determined by lt) appear in the same order in the sorted NonEmptyString as in the original.

Attributes

ord

the Ordering to be used to compare elements.

Returns:

a NonEmptyString consisting of the characters of this NonEmptyString sorted according to the ordering defined by ord.

def startsWith(that: Seq[Char]): Boolean

Indicates whether this NonEmptyString starts with the given Seq.

Indicates whether this NonEmptyString starts with the given Seq.

Attributes

that

the Seq slice to look for in this NonEmptyString

Returns:

true if this NonEmptyString has that as a prefix, false otherwise.

def startsWith(that: Seq[Char], offset: Int): Boolean

Indicates whether this NonEmptyString starts with the given Seq at the given index.

Indicates whether this NonEmptyString starts with the given Seq at the given index.

Attributes

offset

the index at which this NonEmptyString is searched.

that

the Seq slice to look for in this NonEmptyString

Returns:

true if this NonEmptyString has that as a slice at the index offset, false otherwise.

def startsWith(that: Vector[Char]): Boolean

Indicates whether this NonEmptyString starts with the given Vector.

Indicates whether this NonEmptyString starts with the given Vector.

Attributes

that

the Vector to test

Returns:

true if this collection has that as a prefix, false otherwise.

def startsWith(that: NonEmptyString): Boolean

Indicates whether this NonEmptyString starts with the given NonEmptyString.

Indicates whether this NonEmptyString starts with the given NonEmptyString.

Attributes

that

the NonEmptyString to test

Returns:

true if this collection has that as a prefix, false otherwise.

def startsWith(that: Vector[Char], offset: Int): Boolean

Indicates whether this NonEmptyString starts with the given Vector at the given index.

Indicates whether this NonEmptyString starts with the given Vector at the given index.

Attributes

offset

the index at which this NonEmptyString is searched.

that

the Vector slice to look for in this NonEmptyString

Returns:

true if this NonEmptyString has that as a slice at the index offset, false otherwise.

def startsWith(that: NonEmptyString, offset: Int): Boolean

Indicates whether this NonEmptyString starts with the given NonEmptyString at the given index.

Indicates whether this NonEmptyString starts with the given NonEmptyString at the given index.

Attributes

offset

the index at which this NonEmptyString is searched.

that

the NonEmptyString slice to look for in this NonEmptyString

Returns:

true if this NonEmptyString has that as a slice at the index offset, false otherwise.

def stringPrefix: String

Returns "NonEmptyString", the prefix of this object's toString representation.

Returns "NonEmptyString", the prefix of this object's toString representation.

Attributes

Returns:

the string "NonEmptyString"

def sum(implicit num: Numeric[Long]): Long

The result of summing all the characters of this NonEmptyString.

The result of summing all the characters of this NonEmptyString.

This method can be invoked for any NonEmptyString for which an implicit Numeric[Char] exists.

Attributes

Returns:

the sum of all elements

def tail: String
def to[C1](factory: Factory[Char, C1]): C1

Converts this NonEmptyString into a collection of type Col by copying all elements.

Converts this NonEmptyString into a collection of type Col by copying all elements.

Attributes

C1

the collection type to build.

Returns:

a new collection containing all elements of this NonEmptyString.

def toArray(implicit classTag: ClassTag[Char]): Array[Char]

Converts this NonEmptyString to an array.

Converts this NonEmptyString to an array.

Attributes

Returns:

an array containing all characters of this NonEmptyString. A ClassTag must be available for the element type of this NonEmptyString.

def toBuffer: Buffer[Char]

Converts this NonEmptyString to a mutable buffer.

Converts this NonEmptyString to a mutable buffer.

Attributes

Returns:

a buffer containing all characters of this NonEmptyString.

def toIndexedSeq: IndexedSeq[Char]

Converts this NonEmptyString to an immutable IndexedSeq.

Converts this NonEmptyString to an immutable IndexedSeq.

Attributes

Returns:

an immutable IndexedSeq containing all characters of this NonEmptyString.

def toIterable: Iterable[Char]

Converts this NonEmptyString to an iterable collection.

Converts this NonEmptyString to an iterable collection.

Attributes

Returns:

an Iterable containing all characters of this NonEmptyString.

def toIterator: Iterator[Char]

Returns an Iterator over the elements in this NonEmptyString.

Returns an Iterator over the elements in this NonEmptyString.

Attributes

Returns:

an Iterator containing all characters of this NonEmptyString.

def toMap: Map[Int, Char]

Converts this NonEmptyString to a map.

Converts this NonEmptyString to a map.

This method is unavailable unless the elements are members of Tuple2, each ((K, V)) becoming a key-value pair in the map. Duplicate keys will be overwritten by later keys.

Attributes

Returns:

a map of type immutable.Map[Int, Char] containing all index/character pairs of type (Int, Char) of this NonEmptyString.

def toSeq: Seq[Char]

Converts this NonEmptyString to an immutable IndexedSeq.

Converts this NonEmptyString to an immutable IndexedSeq.

Attributes

Returns:

an immutable IndexedSeq containing all characters of this NonEmptyString.

def toSet: Set[Char]

Converts this NonEmptyString to a set.

Converts this NonEmptyString to a set.

Attributes

Returns:

a set containing all characters of this NonEmptyString.

override def toString: String

Returns a string representation of this NonEmptyString.

Returns a string representation of this NonEmptyString.

Attributes

Returns:

the string "NonEmptyString" followed by the result of invoking toString on this NonEmptyString's elements, surrounded by parentheses.

Definition Classes
Any
def toVector: Vector[Char]

Converts this NonEmptyString to a Vector.

Converts this NonEmptyString to a Vector.

Attributes

Returns:

a Vector containing all characters of this NonEmptyString.

def union(that: Vector[Char]): NonEmptyString

Produces a new NonEmptyString that contains all characters of this NonEmptyString and also all characters of a given Vector.

Produces a new NonEmptyString that contains all characters of this NonEmptyString and also all characters of a given Vector.

nonEmptyStringX union everyY is equivalent to nonEmptyStringX ++ everyY.

Another way to express this is that nonEmptyStringX union everyY computes the order-presevring multi-set union of nonEmptyStringX and everyY. This union method is hence a counter-part of diff and intersect that also work on multi-sets.

Attributes

that

the Vector to add.

Returns:

a new NonEmptyString that contains all characters of this NonEmptyString followed by all characters of that Vector.

def union(that: NonEmptyString): NonEmptyString

Produces a new NonEmptyString that contains all characters of this NonEmptyString and also all characters of a given NonEmptyString.

Produces a new NonEmptyString that contains all characters of this NonEmptyString and also all characters of a given NonEmptyString.

nonEmptyStringX union nonEmptyStringY is equivalent to nonEmptyStringX ++ nonEmptyStringY.

Another way to express this is that nonEmptyStringX union nonEmptyStringY computes the order-presevring multi-set union of nonEmptyStringX and nonEmptyStringY. This union method is hence a counter-part of diff and intersect that also work on multi-sets.

Attributes

that

the NonEmptyString to add.

Returns:

a new NonEmptyString that contains all elements of this NonEmptyString followed by all characters of that.

def union(that: Seq[Char]): NonEmptyString

Produces a new NonEmptyString that contains all characters of this NonEmptyString and also all characters of a given Seq.

Produces a new NonEmptyString that contains all characters of this NonEmptyString and also all characters of a given Seq.

nonEmptyStringX union ys is equivalent to nonEmptyStringX ++ ys.

Another way to express this is that nonEmptyStringX union ys computes the order-presevring multi-set union of nonEmptyStringX and ys. This union method is hence a counter-part of diff and intersect that also work on multi-sets.

Attributes

that

the Seq to add.

Returns:

a new NonEmptyString that contains all elements of this NonEmptyString followed by all elements of that Seq.

def unzip[L, R](implicit asPair: Char => (L, R)): (Iterable[L], Iterable[R])

Converts this NonEmptyString of pairs into two NonEmptyStrings of the first and second half of each pair.

Converts this NonEmptyString of pairs into two NonEmptyStrings of the first and second half of each pair.

Attributes

L

the type of the first half of the character pairs

R

the type of the second half of the character pairs

asPair

an implicit conversion that asserts that the character type of this NonEmptyString is a pair.

Returns:

a pair of NonEmptyStrings, containing the first and second half, respectively, of each character pair of this NonEmptyString.

def unzip3[L, M, R](implicit asTriple: Char => (L, M, R)): (Iterable[L], Iterable[M], Iterable[R])

Converts this NonEmptyString of triples into three NonEmptyStrings of the first, second, and and third character of each triple.

Converts this NonEmptyString of triples into three NonEmptyStrings of the first, second, and and third character of each triple.

Attributes

L

the type of the first member of the character triples

R

the type of the third member of the character triples

asTriple

an implicit conversion that character that the character type of this NonEmptyString is a triple.

Returns:

a triple of NonEmptyStrings, containing the first, second, and third member, respectively, of each character triple of this NonEmptyString.

def updated(idx: Int, c: Char): NonEmptyString

A copy of this NonEmptyString with one single replaced character.

A copy of this NonEmptyString with one single replaced character.

Attributes

c

the replacing character

idx

the position of the replacement

Returns:

a copy of this NonEmptyString with the character at position idx replaced by c.

Throws:
IndexOutOfBoundsException

if the passed index is greater than or equal to the length of this NonEmptyString

def zipAll[O](other: Iterable[O], thisElem: Char, otherElem: O): Iterable[(Char, O)]

Returns a NonEmptyString formed from this NonEmptyString and an iterable collection by combining corresponding elements in pairs. If one of the two collections is shorter than the other, placeholder elements will be used to extend the shorter collection to the length of the longer.

Returns a NonEmptyString formed from this NonEmptyString and an iterable collection by combining corresponding elements in pairs. If one of the two collections is shorter than the other, placeholder elements will be used to extend the shorter collection to the length of the longer.

Attributes

O

the element type of the other

other

the Iterable providing the second half of each result pair

otherElem

the element to be used to fill up the result if that Iterable is shorter than this NonEmptyString.

thisElem

the element to be used to fill up the result if this NonEmptyString is shorter than that Iterable.

Returns:

a new NonEmptyString containing pairs consisting of corresponding characters of this NonEmptyString and that. The length of the returned collection is the maximum of the lengths of this NonEmptyString and that. If this NonEmptyString is shorter than that, thisElem values are used to pad the result. If that is shorter than this NonEmptyString, thatElem values are used to pad the result.

def zipAll(other: NonEmptyString, thisElem: Char, otherElem: Char): Iterable[(Char, Char)]

Returns a NonEmptyString formed from this NonEmptyString and another NonEmptyString combining corresponding elements in pairs. If one of the two is shorter than the other, placeholder elements will be used to extend the shorter collection to the length of the longer.

Returns a NonEmptyString formed from this NonEmptyString and another NonEmptyString combining corresponding elements in pairs. If one of the two is shorter than the other, placeholder elements will be used to extend the shorter collection to the length of the longer.

Attributes

other

the NonEmptyString providing the second half of each result pair

otherElem

the character to be used to fill up the result if that Iterable is shorter than this NonEmptyString.

thisElem

the character to be used to fill up the result if this NonEmptyString is shorter than that NonEmptyString.

Returns:

a new NonEmptyString containing pairs consisting of corresponding characters of this NonEmptyString and that. The length of the returned collection is the maximum of the lengths of this NonEmptyString and that. If this NonEmptyString is shorter than that, thisElem values are used to pad the result. If that is shorter than this NonEmptyString, thatElem values are used to pad the result.

def zipWithIndex: Iterable[(Char, Int)]

Zips this NonEmptyString with its indices.

Zips this NonEmptyString with its indices.

Attributes

Returns:

A new NonEmptyString containing pairs consisting of all elements of this NonEmptyString paired with their index. Indices start at 0.

Concrete fields

val theString: String
Generated with