Slice

org.typelevel.jawn.util.Slice
See theSlice companion object
final class Slice extends CharSequence, Serializable

Character sequence representing a lazily-calculated substring.

This class has three constructors:

  • Slice(s) wraps a string, ensuring that future operations (e.g. subSequence) will construct slices instead of strings.

  • Slice(s, start, limit) is the default, and ensures that:

  1. start >= 0 2. limit >= start 3. limit <= s.length
  • Slice.unsafe(s, start, limit) is for situations where the above bounds-checking has already occurred. Only use this if you are absolutely sure your arguments satisfy the above invariants.

Slice's subSequence returns another slice. This means that when wrapping a very large string, garbage collection on the underlying string will not occur until all slices are freed.

Slice's universal equality is only defined with regard to other slices. This means comparing a Slice with other CharSequence values (including String) will always return false.

Slices are serializable. However! They use the default Java serialization layout, which is not that efficient, and could be a disaster in cases where a large shared string might be serialized many times in different slices.

Attributes

Companion
object
Source
Slice.scala
Graph
Supertypes
trait Serializable
trait CharSequence
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

def charAt(i: Int): Char

Attributes

Source
Slice.scala
override def equals(that: Any): Boolean

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 x of type Any, x.equals(x) should return true.
  • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

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.

Attributes

Returns

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
Any
Source
Slice.scala
override def hashCode: Int

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.

Attributes

Returns

the hash code value for this object.

Definition Classes
Any
Source
Slice.scala
def subSequence(i: Int, j: Int): Slice

Attributes

Source
Slice.scala
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
CharSequence -> Any
Source
Slice.scala

Inherited methods

def chars(): IntStream

Attributes

Inherited from:
CharSequence

Attributes

Inherited from:
CharSequence

Concrete fields

final val length: Int

Attributes

Source
Slice.scala