Record Class PacketReading.Result.Failure<T>

java.lang.Object
java.lang.Record
net.minestom.server.network.packet.PacketReading.Result.Failure<T>
All Implemented Interfaces:
PacketReading.Result<T>
Enclosing interface:
PacketReading.Result<T>
public static record PacketReading.Result.Failure<T>(long requiredCapacity) extends Record implements PacketReading.Result<T>
Represents a failure to read a packet due to insufficient buffer capacity.

Buffer should be expanded to at least requiredCapacity bytes.

If the buffer does not allow to read the packet length, max var-int length is returned.

  • Constructor Details

    • Failure

      public Failure(long requiredCapacity)
      Creates an instance of a Failure record class.
      Parameters:
      requiredCapacity - the value for the requiredCapacity record component

  • Method Details

    • 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. All components in this record class are compared with the compare method from their corresponding wrapper classes.
      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.

    • requiredCapacity

      public long requiredCapacity()
      Returns the value of the requiredCapacity record component.
      Returns:
      the value of the requiredCapacity record component