Scalactic 3.3.0-alpha.1
API
Generated with
Scalactic 3.3.0-alpha.1/org.scalactic/org.scalactic.anyvals/NonEmptyString

NonEmptyString

org.scalactic.anyvals.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 Every.

== 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
Source
NonEmptyString.scala
Graph
Supertypes
class AnyVal
trait Matchable
class Any

Members list

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.

Value parameters

other

the NonEmptyString to append

Attributes

Returns

a new NonEmptyString that contains this NonEmptyString followed by other.

Source
NonEmptyString.scala
def ++(other: Every[Char]): NonEmptyString

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

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

Value parameters

other

the Every of Char to append

Attributes

Returns

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

Source
NonEmptyString.scala
def ++(other: IterableOnce[Char]): NonEmptyString

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

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

Value parameters

other

the IterableOnce of Char to append

Attributes

Returns

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

Source
NonEmptyString.scala
final 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.

Value parameters

c

the character to prepend to this NonEmptyString

Attributes

Returns

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

Source
NonEmptyString.scala
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.

Value parameters

c

the character to append to this NonEmptyString

Attributes

Returns

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

Source
NonEmptyString.scala
final 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.

Value parameters

sb

the string builder to which characters will be appended

Attributes

Returns

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

Source
NonEmptyString.scala
final 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.

Value parameters

sb

the string builder to which characters will be appended

sep

the separator string

Attributes

Returns

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

Source
NonEmptyString.scala
final 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

Value parameters

end

the ending string

sb

the string builder to which characters will be appended

sep

the separator string

start

the starting string

Attributes

Returns

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

Source
NonEmptyString.scala
final 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.

Source
NonEmptyString.scala
final 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.

Source
NonEmptyString.scala
final 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.

Value parameters

pf

the partial function

Attributes

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.

Source
NonEmptyString.scala
final 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.

Value parameters

c

the element to look for

Attributes

Returns

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

Source
NonEmptyString.scala
final def containsSlice(that: Seq[Char]): Boolean

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

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

Value parameters

that

the GenSeq character slice to look for

Attributes

Returns

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

Source
NonEmptyString.scala
final def containsSlice(that: Every[Char]): Boolean

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

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

Value parameters

that

the Every character slice to look for

Attributes

Returns

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

Source
NonEmptyString.scala
final 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.

Value parameters

that

the NonEmptyString slice to look for

Attributes

Returns

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

Source
NonEmptyString.scala
final 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.

Value parameters

arr

the array to fill

Attributes

Source
NonEmptyString.scala
final 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.

Value parameters

arr

the array to fill

start

the starting index

Attributes

Source
NonEmptyString.scala
final 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.

Value parameters

arr

the array to fill

len

the maximum number of elements to copy

start

the starting index

Attributes

Source
NonEmptyString.scala
final def copyToBuffer(buf: Buffer[Char]): Unit

Copies all characters of this NonEmptyString to a buffer.

Copies all characters of this NonEmptyString to a buffer.

Value parameters

buf

the buffer to which characters are copied

Attributes

Source
NonEmptyString.scala
final 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 GenSeq by satisfying a given predicate.

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

Type parameters

B

the type of the elements of that

Value parameters

p

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

that

the GenSeq to compare for correspondence

Attributes

Returns

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

Source
NonEmptyString.scala
final def corresponds[B](that: Every[B])(p: (Char, B) => Boolean): Boolean

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

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

Type parameters

B

the type of the elements of that

Value parameters

p

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

that

the Every to compare for correspondence

Attributes

Returns

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

Source
NonEmptyString.scala
final 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.

Value parameters

p

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

that

the NonEmptyString to compare for correspondence

Attributes

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.

Source
NonEmptyString.scala
final 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.

Value parameters

p

the predicate used to test characters.

Attributes

Returns

the number of characters satisfying the predicate p.

Source
NonEmptyString.scala
final 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.

Source
NonEmptyString.scala
final def endsWith[B](that: Seq[B]): Boolean

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

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

Value parameters

that

the sequence to test

Attributes

Returns

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

Source
NonEmptyString.scala
final def endsWith[B](that: Every[B]): Boolean

Indicates whether this NonEmptyString ends with the given Every.

Indicates whether this NonEmptyString ends with the given Every.

Value parameters

that

the Every to test

Attributes

Returns

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

Source
NonEmptyString.scala
final def endsWith(that: NonEmptyString): Boolean

Indicates whether this NonEmptyString ends with the given NonEmptyString.

Indicates whether this NonEmptyString ends with the given NonEmptyString.

Value parameters

that

the NonEmptyString to test

Attributes

Returns

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

Source
NonEmptyString.scala
final 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.

Value parameters

p

the predicate used to test characters.

Attributes

Returns

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

Source
NonEmptyString.scala
final 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.

Value parameters

p

the predicate used to test characters

Attributes

Returns

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

Source
NonEmptyString.scala
final 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.

Value parameters

f

the function to apply to each character.

Attributes

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.

Source
NonEmptyString.scala
final 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.

Value parameters

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.)

Attributes

Returns

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

Source
NonEmptyString.scala
final 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.

Type parameters

B

the result type of the binary operator.

Value parameters

op

the binary operator.

z

the start value.

Attributes

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.

Source
NonEmptyString.scala
final 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.

Type parameters

B

the result of the binary operator

Value parameters

op

the binary operator

z

the start value

Attributes

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.

Source
NonEmptyString.scala
final 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.

Value parameters

p

the predicate used to test characters.

Attributes

Returns

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

Source
NonEmptyString.scala
final 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.

Value parameters

f

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

Attributes

Source
NonEmptyString.scala
final 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.

Type parameters

K

the type of keys returned by the discriminator function.

Value parameters

f

the discriminator function.

Attributes

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.

Source
NonEmptyString.scala
final def grouped(size: Int): Iterator[NonEmptyString]

Partitions characters into fixed size NonEmptyStrings.

Partitions characters into fixed size NonEmptyStrings.

Value parameters

size

the number of characters per group

Attributes

Returns

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

Source
NonEmptyString.scala
final 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

Source
NonEmptyString.scala
final 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.

Source
NonEmptyString.scala
final def headOption: Option[Char]

Selects the first character of this NonEmptyString and returns it wrapped in a Some.

Selects the first character of this NonEmptyString and returns it wrapped in a Some.

Attributes

Returns

the first character of this NonEmptyString, wrapped in a Some.

Source
NonEmptyString.scala
final 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.

Value parameters

c

the character value to search for.

Attributes

Returns

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

Source
NonEmptyString.scala
final 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.

Value parameters

c

the character value to search for.

from

the start index

Attributes

Returns

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

Source
NonEmptyString.scala
final def indexOfSlice(that: Seq[Char]): Int

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

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

Value parameters

that

the GenSeq[Char] defining the slice to look for

Attributes

Returns

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

Source
NonEmptyString.scala
final def indexOfSlice(that: Seq[Char], from: Int): Int

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

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

Value parameters

from

the start index

that

the GenSeq[Char] defining the slice to look for

Attributes

Returns

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

Source
NonEmptyString.scala
final def indexOfSlice(that: Every[Char]): Int

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

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

Value parameters

that

the Every defining the slice to look for

Attributes

Returns

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

Source
NonEmptyString.scala
final 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.

Value parameters

that

the NonEmptyString defining the slice to look for

Attributes

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.

Source
NonEmptyString.scala
final def indexOfSlice(that: Every[Char], from: Int): Int

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

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

Value parameters

from

the start index

that

the Every defining the slice to look for

Attributes

Returns

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

Source
NonEmptyString.scala
final 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.

Value parameters

from

the start index

that

the NonEmptyString defining the slice to look for

Attributes

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.

Source
NonEmptyString.scala
final def indexWhere(p: Char => Boolean): Int

Finds index of the first character satisfying some predicate.

Finds index of the first character satisfying some predicate.

Value parameters

p

the predicate used to test characters.

Attributes

Returns

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

Source
NonEmptyString.scala
final 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.

Value parameters

from

the start index

p

the predicate used to test characters.

Attributes

Returns

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

Source
NonEmptyString.scala
final 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.

Source
NonEmptyString.scala
final def isDefinedAt(idx: Int): Boolean

Tests whether this NonEmptyString contains given index.

Tests whether this NonEmptyString contains given index.

Value parameters

idx

the index to test

Attributes

Returns

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

Source
NonEmptyString.scala
final 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

Source
NonEmptyString.scala
final 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

Source
NonEmptyString.scala
final 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

Source
NonEmptyString.scala
final 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.

Source
NonEmptyString.scala
final 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.

Value parameters

c

the character value to search for.

Attributes

Returns

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

Source
NonEmptyString.scala
final 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.

Value parameters

c

the character value to search for.

end

the end index.

Attributes

Returns

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

Source
NonEmptyString.scala
final def lastIndexOfSlice(that: Seq[Char]): Int

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

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

Value parameters

that

the GenSeq defining the slice to look for

Attributes

Returns

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

Source
NonEmptyString.scala
final 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 GenSeq as a slice.

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

Value parameters

end

the end index

that

the GenSeq defining the slice to look for

Attributes

Returns

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

Source
NonEmptyString.scala
final def lastIndexOfSlice(that: Every[Char]): Int

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

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

Value parameters

that

the Every defining the slice to look for

Attributes

Returns

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

Source
NonEmptyString.scala
final 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.

Value parameters

that

the NonEmptyString defining the slice to look for

Attributes

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.

Source
NonEmptyString.scala
final def lastIndexOfSlice(that: Every[Char], end: Int): Int

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

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

Value parameters

end

the end index

that

the Every defining the slice to look for

Attributes

Returns

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

Source
NonEmptyString.scala
final 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.

Value parameters

end

the end index

that

the NonEmptyString defining the slice to look for

Attributes

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.

Source
NonEmptyString.scala
final def lastIndexWhere(p: Char => Boolean): Int

Finds index of last character satisfying some predicate.

Finds index of last character satisfying some predicate.

Value parameters

p

the predicate used to test characters.

Attributes

Returns

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

Source
NonEmptyString.scala
final 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.

Value parameters

end

the end index

p

the predicate used to test characters.

Attributes

Returns

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

Source
NonEmptyString.scala
final def lastOption: Option[Char]

Returns the last element of this NonEmptyString, wrapped in a Some.

Returns the last element of this NonEmptyString, wrapped in a Some.

Attributes

Returns

the last element, wrapped in a Some.

Source
NonEmptyString.scala
final def length: Int

The length of this NonEmptyString.

The length of this NonEmptyString.

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

Attributes

Returns

the number of characters in this NonEmptyString.

Source
NonEmptyString.scala
final 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.

Value parameters

len

the test value that gets compared with the length.

Attributes

Returns

a value x where

x < 0 if this.length < len
x == 0 if this.length == len
x > 0 if this.length > len
Source
NonEmptyString.scala
final 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.

Type parameters

U

the character type of the returned NonEmptyString.

Value parameters

f

the function to apply to each character.

Attributes

Returns

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

Source
NonEmptyString.scala
final def max(implicit cmp: Ordering[Char]): Char

Finds the largest character.

Finds the largest character.

Attributes

Returns

the largest element of this NonEmptyString.

Source
NonEmptyString.scala
final 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.

Source
NonEmptyString.scala
final def min(implicit cmp: Ordering[Char]): Char

Finds the smallest character.

Finds the smallest character.

Attributes

Returns

the smallest character of this NonEmptyString.

Source
NonEmptyString.scala
final 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.

Source
NonEmptyString.scala
final 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.

Source
NonEmptyString.scala
final 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.

Value parameters

sep

the separator string

Attributes

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.

Source
NonEmptyString.scala
final 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.

Value parameters

end

the ending string.

sep

the separator string.

start

the starting string.

Attributes

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.

Source
NonEmptyString.scala
final 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

Source
NonEmptyString.scala
final 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.

Value parameters

c

the padding character

len

the target length

Attributes

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.

Source
NonEmptyString.scala
final 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

Value parameters

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

Attributes

Source
NonEmptyString.scala
final 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.

Source
NonEmptyString.scala
final 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.

Value parameters

p

the predicate used to test characters.

Attributes

Returns

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

Source
NonEmptyString.scala
final 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

Source
NonEmptyString.scala
final 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.

Value parameters

op

a binary operator that must be associative.

Attributes

Returns

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

Source
NonEmptyString.scala
final 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.

Value parameters

op

the binary operator.

Attributes

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.

Source
NonEmptyString.scala
final 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.

Value parameters

op

the binary operator.

Attributes

Returns

a Some containing the result of reduceLeft(op)

Source
NonEmptyString.scala
final def reduceOption(op: (Char, Char) => Char): Option[Char]

Attributes

Source
NonEmptyString.scala
final 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.

Value parameters

op

the binary operator

Attributes

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.

Source
NonEmptyString.scala
final 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.

Value parameters

op

the binary operator

Attributes

Returns

a Some containing the result of reduceRight(op)

Source
NonEmptyString.scala
final 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.

Source
NonEmptyString.scala
final def reverseIterator: Iterator[Char]

An iterator yielding characters in reverse order.

An iterator yielding characters in reverse order.

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

Attributes

Returns

an iterator yielding the characters of this NonEmptyString in reversed order

Source
NonEmptyString.scala
final def reverseMap[U](f: Char => U): Iterable[U]

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

Builds a new GenIterable by applying a function to all characters 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.

Type parameters

U

the element type of the returned GenIterable.

Value parameters

f

the function to apply to each character.

Attributes

Returns

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

Source
NonEmptyString.scala
final def sameElements(that: Iterable[Char]): Boolean

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

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

Value parameters

that

the GenIterable with which to compare

Attributes

Returns

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

Source
NonEmptyString.scala
final def sameElements(that: Every[Char]): Boolean

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

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

Value parameters

that

the Every with which to compare

Attributes

Returns

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

Source
NonEmptyString.scala
final 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.

Value parameters

that

the NonEmptyString with which to compare

Attributes

Returns

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

Source
NonEmptyString.scala
final 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.

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")

Value parameters

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.)

Attributes

Returns

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

Source
NonEmptyString.scala
final 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")

Type parameters

B

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

Value parameters

op

the binary operator.

z

the start value.

Attributes

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.

Source
NonEmptyString.scala
final 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")

Type parameters

B

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

Value parameters

op

the binary operator

z

the start value

Attributes

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.

Source
NonEmptyString.scala
final 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.

Value parameters

from

the index where the search starts.

p

the predicate used to test elements.

Attributes

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.

Source
NonEmptyString.scala
final def size: Int

The size of this NonEmptyString.

The size of this NonEmptyString.

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

Attributes

Returns

the number of characters in this NonEmptyString.

Source
NonEmptyString.scala
final 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.)

Value parameters

size

the number of characters per group

Attributes

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.

Source
NonEmptyString.scala
final 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.

Value parameters

size

the number of characters per group

step

the distance between the first characters of successive groups

Attributes

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.

Source
NonEmptyString.scala
final 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.

Type parameters

U

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

Value parameters

f

the transformation function mapping elements to some other domain U.

ord

the ordering assumed on domain U.

Attributes

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)).

Source
NonEmptyString.scala
final 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.

Value parameters

lt

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

Attributes

Returns

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

Source
NonEmptyString.scala
final 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.

Value parameters

ord

the Ordering to be used to compare elements.

Attributes

Returns

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

Source
NonEmptyString.scala
final def startsWith(that: Seq[Char]): Boolean

Indicates whether this NonEmptyString starts with the given GenSeq.

Indicates whether this NonEmptyString starts with the given GenSeq.

Value parameters

that

the GenSeq slice to look for in this NonEmptyString

Attributes

Returns

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

Source
NonEmptyString.scala
final def startsWith(that: Seq[Char], offset: Int): Boolean

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

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

Value parameters

offset

the index at which this NonEmptyString is searched.

that

the GenSeq slice to look for in this NonEmptyString

Attributes

Returns

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

Source
NonEmptyString.scala
final def startsWith(that: Every[Char]): Boolean

Indicates whether this NonEmptyString starts with the given Every.

Indicates whether this NonEmptyString starts with the given Every.

Value parameters

that

the Every to test

Attributes

Returns

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

Source
NonEmptyString.scala
final def startsWith(that: NonEmptyString): Boolean

Indicates whether this NonEmptyString starts with the given NonEmptyString.

Indicates whether this NonEmptyString starts with the given NonEmptyString.

Value parameters

that

the NonEmptyString to test

Attributes

Returns

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

Source
NonEmptyString.scala
final def startsWith(that: Every[Char], offset: Int): Boolean

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

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

Value parameters

offset

the index at which this NonEmptyString is searched.

that

the Every slice to look for in this NonEmptyString

Attributes

Returns

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

Source
NonEmptyString.scala
final 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.

Value parameters

offset

the index at which this NonEmptyString is searched.

that

the NonEmptyString slice to look for in this NonEmptyString

Attributes

Returns

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

Source
NonEmptyString.scala
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"

Source
NonEmptyString.scala
final def sum(implicit num: Numeric[Char]): 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

Source
NonEmptyString.scala
final def to[Col[_]](factory: Factory[Char, Col[Char]]): Col[Char]

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.

Type parameters

Col

the collection type to build.

Attributes

Returns

a new collection containing all elements of this NonEmptyString.

Source
NonEmptyString.scala
final 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.

Source
NonEmptyString.scala
final 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.

Source
NonEmptyString.scala
final 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.

Source
NonEmptyString.scala
final 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.

Source
NonEmptyString.scala
final 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.

Source
NonEmptyString.scala
final 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.

Source
NonEmptyString.scala
final 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.

Source
NonEmptyString.scala
final 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.

Source
NonEmptyString.scala
final def toStream: Stream[Char]

Converts this NonEmptyString to a stream.

Converts this NonEmptyString to a stream.

Attributes

Returns

a stream containing all characters of this NonEmptyString.

Source
NonEmptyString.scala
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
Source
NonEmptyString.scala
final 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.

Source
NonEmptyString.scala
final def union(that: Every[Char]): NonEmptyString

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

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

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.

Value parameters

that

the Every to add.

Attributes

Returns

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

Source
NonEmptyString.scala
final 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.

Value parameters

that

the NonEmptyString to add.

Attributes

Returns

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

Source
NonEmptyString.scala
final def union(that: Seq[Char]): NonEmptyString

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

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

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.

Value parameters

that

the GenSeq to add.

Attributes

Returns

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

Source
NonEmptyString.scala
final 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.

Type parameters

L

the type of the first half of the character pairs

R

the type of the second half of the character pairs

Value parameters

asPair

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

Attributes

Returns

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

Source
NonEmptyString.scala
final 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.

Type parameters

L

the type of the first member of the character triples

R

the type of the third member of the character triples

Value parameters

asTriple

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

Attributes

Returns

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

Source
NonEmptyString.scala
final 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.

Value parameters

c

the replacing character

idx

the position of the replacement

Attributes

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

Source
NonEmptyString.scala
final 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.

Type parameters

O

the element type of the other

Value parameters

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.

Attributes

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.

Source
NonEmptyString.scala
final 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.

Value parameters

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.

Attributes

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.

Source
NonEmptyString.scala
final 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.

Source
NonEmptyString.scala

Concrete fields

val theString: String

Attributes

Source
NonEmptyString.scala
Generated with