A JSON document held as a '''slice''' of a byte array: length bytes of array from offset on. The source (and, through .raw, the focus) of the in-place optics JsoniterInPlacePrism and JsoniterInPlaceTraversal — JsoniterPrism.inPlace[A], prism.inPlace, traversal.inPlace — which read a JSON value where it lies, without first copying it into an array of its own: a message cut out of a network buffer, say.
A slice is a '''view''', not a copy:
Building one copies nothing, and an optic reads the array as it is when it runs. '''Don't''' '''mutate the array''' while the slice, or anything read from it, is in use.
A slice keeps the '''whole''' array reachable, however few bytes it covers: a 300-byte slice of a 256 KiB read pins the 256 KiB. Call toArray for anything kept long-term.
Equality is by '''content''': two slices are equal when they hold the same bytes, wherever they sit in whatever arrays. So a slice in the middle of a larger buffer equals the same bytes copied out, and the optic laws can compare slices with ==.
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.
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.