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,subStringandStr.parse) speedups
- Companion:
- object
Value members
Concrete methods
Compares the receiver object (this) with the argument object (that) for equivalence.
Compares the receiver object (this) with the argument object (that) for equivalence.
Any implementation of this method should be an equivalence relation:
- It is reflexive: for any instance
xof typeAny,x.equals(x)should returntrue. - It is symmetric: for any instances
xandyof typeAny,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any instances
x,y, andzof typeAnyifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue.
If you override this method, you should verify that your implementation remains an equivalence relation.
Additionally, when overriding this method it is usually necessary to override hashCode to ensure that
objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int.
(o1.hashCode.equals(o2.hashCode)).
- Value parameters:
- that
the object to compare against this object for equality.
- Returns:
trueif the receiver object is equivalent to the argument;falseotherwise.- Definition Classes
- Equals -> Any
Retrieve the character of this string at the given character index
Retrieve the character of this string at the given character index
Returns a copy of the character array backing this fansi.Str, in case you want to use it to
Returns a copy of the character array backing this fansi.Str, in case you want to use it to
Retrieve the color of this string at the given character index
Retrieve the color of this string at the given character index
Returns a copy of the colors array backing this fansi.Str, in case you want to use it to
Returns a copy of the colors array backing this fansi.Str, in case you want to use it to
Calculate a hash code value for the object.
Calculate a hash code value for the object.
The default hashing algorithm is platform dependent.
Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet
not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0.
However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have
identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure
to verify that the behavior is consistent with the equals method.
- Returns:
the hash code value for this object.
- Definition Classes
- Any
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
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
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.
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.