final class Secret[T](var offuscatedValue: Array[Byte], seed: Seed)
The Secret class represent a secret value of type T.
The value is implicitly offuscated when creating the Secret instance using an implicit Offuser instance which, by default, transform the value into a shuffled Array[Byte].
The offuscated value is de-offuscated using an implicit DeOffuser instance every time the method use is invoked which returns the original value un-shuffling the bytes and converting them back to T.
Example
val secretString: Secret[String] = Secret("my_password")
val secretValue: Either[NoLongerValidSecret, String] = secretString.use
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.