Record Class WGPUStringView

java.lang.Object
java.lang.Record
club.doki7.webgpu.datatype.WGPUStringView
All Implemented Interfaces:
IPointer, IWGPUStringView
@ValueBasedCandidate @UnsafeConstructor public record WGPUStringView(@NotNull MemorySegment segment) extends Record implements IWGPUStringView

Represents a pointer to a WGPUStringView structure in native memory.

Structure

typedef struct WGPUStringView {
    char const* data; // optional
    size_t length;
} WGPUStringView;

Contracts

The property segment() should always be not-null (segment != NULL && !segment.equals(MemorySegment.NULL)), and properly aligned to LAYOUT.byteAlignment() bytes. To represent null pointer, you may use a Java null instead. See the documentation of IPointer.segment() for more details.

The constructor of this class is marked as UnsafeConstructor, because it does not perform any runtime check. The constructor can be useful for automatic code generators.

  • Field Details

    • LAYOUT

      public static final StructLayout LAYOUT

    • BYTES

      public static final long BYTES

    • PATH$data

      public static final MemoryLayout.PathElement PATH$data

    • PATH$length

      public static final MemoryLayout.PathElement PATH$length

    • LAYOUT$data

      public static final AddressLayout LAYOUT$data

    • SIZE$data

      public static final long SIZE$data

    • SIZE$length

      public static final long SIZE$length

    • OFFSET$data

      public static final long OFFSET$data

    • OFFSET$length

      public static final long OFFSET$length

  • Constructor Details

    • WGPUStringView

      public WGPUStringView(@NotNull @NotNull MemorySegment segment)
      Creates an instance of a WGPUStringView record class.
      Parameters:
      segment - the value for the segment record component

  • Method Details

    • allocate

      public static WGPUStringView allocate(Arena arena)

    • allocate

      public static WGPUStringView.Ptr allocate(Arena arena, long count)

    • clone

      public static WGPUStringView clone(Arena arena, WGPUStringView src)

    • data

      @Nullable public @Nullable BytePtr data()
      Note: the returned BytePtr does not have correct BytePtr.size() property. It's up to user to track the size of the buffer, and use BytePtr.reinterpret(long) to set the size before actually reading from or writing to the buffer.

    • data

      public WGPUStringView data(@Nullable @Nullable BytePtr value)

    • dataRaw

      @Pointer(comment="int8_t*") @NotNull public @NotNull MemorySegment dataRaw()

    • dataRaw

      public void dataRaw(@Pointer(comment="int8_t*") @NotNull @NotNull MemorySegment value)

    • length

      @Unsigned public long length()

    • length

      public WGPUStringView length(@Unsigned long value)

    • 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 Objects::equals(Object,Object).
      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.

    • segment

      @NotNull public @NotNull MemorySegment segment()
      Returns the value of the segment record component.
      Specified by:
      segment in interface IPointer
      Returns:
      the value of the segment record component