Str

Encapsulates a string with associated ANSI colors and text decorations.

This is your primary data-type when you are dealing with colored fansi strings.

Contains some basic string methods, as well as some ansi methods to e.g. apply particular colors or other decorations to particular sections of the fansi.Str. render flattens it out into a java.lang.String with all the colors present as ANSI escapes.

Avoids using Scala collections operations in favor of util.Arrays, giving 20% (on ++) to >1000% (on splitAt, subString and Str.parse) speedups

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
def ++(other: Str): Str

Concatenates two fansi.Strs, preserving the colors in each one and avoiding any interference between them
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(other: Any): Boolean

Definition Classes
Str → Equals → AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def getChars: Array[Char]

Returns a copy of the character array backing this fansi.Str, in case you want to use it to
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getColors: Array[State]

Returns a copy of the colors array backing this fansi.Str, in case you want to use it to
def hashCode(): Int

Definition Classes
Str → AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def length: Int

The plain-text length of this fansi.Str, in UTF-16 characters (same as .length on a java.lang.String).
The plain-text length of this fansi.Str, in UTF-16 characters (same as .length on a java.lang.String). If you want fancy UTF-8 lengths, use .plainText
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def overlay(attrs: Attrs, start: Int = 0, end: Int = length): Str

Overlays the desired color over the specified range of the fansi.Str.
def overlayAll(overlays: Seq[(Attrs, Int, Int)]): Str

Batch version of overlay, letting you apply a bunch of Attrs onto various parts of the same string in one operation, avoiding the unnecessary copying that would happen if you applied them with overlay one by one.
Batch version of overlay, letting you apply a bunch of Attrs onto various parts of the same string in one operation, avoiding the unnecessary copying that would happen if you applied them with overlay one by one.
The input sequence of overlay-tuples is applied from left to right
lazy val plainText: String

The plain-text java.lang.String represented by this fansi.Str, without all the fansi colors or other decorations
def render: String

Converts this fansi.Str into a java.lang.String, including all the fancy fansi colors or decorations as fansi escapes embedded within the string.
Converts this fansi.Str into a java.lang.String, including all the fancy fansi colors or decorations as fansi escapes embedded within the string. "Terminates" colors at the right-most end of the resultant java.lang.String, making it safe to concat-with or embed-inside other java.lang.String without worrying about fansi colors leaking out of it.
def splitAt(index: Int): (Str, Str)

Splits an fansi.Str into two sub-strings, preserving the colors in each one.
Splits an fansi.Str into two sub-strings, preserving the colors in each one.
index
the plain-text index of the point within the fansi.Str you want to use to split it.
def substring(start: Int = 0, end: Int = length): Str

Returns an fansi.Str which is a substring of this string, and has the same colors as the original section of this string did
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
Str → AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object Str | package fansi

case class Str extends Product with Serializable

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def ++(other: Str): Str

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(other: Any): Boolean

def finalize(): Unit

def getChars: Array[Char]

final def getClass(): Class[_]

def getColors: Array[State]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def length: Int

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def overlay(attrs: Attrs, start: Int = 0, end: Int = length): Str

def overlayAll(overlays: Seq[(Attrs, Int, Int)]): Str

lazy val plainText: String

def render: String

def splitAt(index: Int): (Str, Str)

def substring(start: Int = 0, end: Int = length): Str

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped