Package dev.turboism.sdk.storage

Record Class StorageReadResult<T>

java.lang.Object
java.lang.Record
dev.turboism.sdk.storage.StorageReadResult<T>
Type Parameters:
T - value type returned by the read operation
Record Components:
value - successfully read value, present exactly when error is empty
error - structured failure, present exactly when value is empty
truncated - whether a successful read stopped at its requested byte limit
public record StorageReadResult<T>(Optional<T> value, Optional<StorageError> error, boolean truncated) extends Record
Structured result of one bounded storage read.

  • Constructor Details

    • StorageReadResult

      public StorageReadResult(Optional<T> value, Optional<StorageError> error, boolean truncated)
      Validates result presence and defensively copies a byte-array value.
      Parameters:
      value - optional successful value
      error - optional structured error
      truncated - whether a successful read stopped at its limit
      Throws:
      NullPointerException - if an optional container is null
      IllegalArgumentException - if both or neither value and error are present, or a failed result is marked truncated

  • Method Details

    • value

      public Optional<T> value()
      Returns the successful value, copying byte arrays on every access.
      Returns:
      the value optional; a returned byte[] is caller-owned and may be mutated

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • error

      public Optional<StorageError> error()
      Returns the value of the error record component.
      Returns:
      the value of the error record component

    • truncated

      public boolean truncated()
      Returns the value of the truncated record component.
      Returns:
      the value of the truncated record component