Record Class SDL_PathInfo

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

Information about a path on the filesystem.

Since: This datatype is available since SDL 3.2.0.

See also:

  • SDL_GetPathInfo
  • SDL_GetStoragePathInfo

Structure

typedef struct SDL_PathInfo {
    SDL_PathType type;
    Uint64 size;
    SDL_Time create_time;
    SDL_Time modify_time;
    SDL_Time access_time;
} SDL_PathInfo;

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$type

      public static final MemoryLayout.PathElement PATH$type

    • PATH$size

      public static final MemoryLayout.PathElement PATH$size

    • PATH$create_time

      public static final MemoryLayout.PathElement PATH$create_time

    • PATH$modify_time

      public static final MemoryLayout.PathElement PATH$modify_time

    • PATH$access_time

      public static final MemoryLayout.PathElement PATH$access_time

    • LAYOUT$type

      public static final ValueLayout.OfInt LAYOUT$type

    • LAYOUT$size

      public static final ValueLayout.OfLong LAYOUT$size

    • LAYOUT$create_time

      public static final ValueLayout.OfLong LAYOUT$create_time

    • LAYOUT$modify_time

      public static final ValueLayout.OfLong LAYOUT$modify_time

    • LAYOUT$access_time

      public static final ValueLayout.OfLong LAYOUT$access_time

    • SIZE$type

      public static final long SIZE$type

    • SIZE$size

      public static final long SIZE$size

    • SIZE$create_time

      public static final long SIZE$create_time

    • SIZE$modify_time

      public static final long SIZE$modify_time

    • SIZE$access_time

      public static final long SIZE$access_time

    • OFFSET$type

      public static final long OFFSET$type

    • OFFSET$size

      public static final long OFFSET$size

    • OFFSET$create_time

      public static final long OFFSET$create_time

    • OFFSET$modify_time

      public static final long OFFSET$modify_time

    • OFFSET$access_time

      public static final long OFFSET$access_time

  • Constructor Details

    • SDL_PathInfo

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

  • Method Details

    • allocate

      public static SDL_PathInfo allocate(Arena arena)

    • allocate

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

    • clone

      public static SDL_PathInfo clone(Arena arena, SDL_PathInfo src)

    • type

      @EnumType(SDL_PathType.class) public int type()

    • type

      public SDL_PathInfo type(@EnumType(SDL_PathType.class) int value)

    • size

      @NativeType("Uint64") @Unsigned public long size()

    • size

      public SDL_PathInfo size(@NativeType("Uint64") @Unsigned long value)

    • create_time

      @NativeType("SDL_Time") public long create_time()

    • create_time

      public SDL_PathInfo create_time(@NativeType("SDL_Time") long value)

    • modify_time

      @NativeType("SDL_Time") public long modify_time()

    • modify_time

      public SDL_PathInfo modify_time(@NativeType("SDL_Time") long value)

    • access_time

      @NativeType("SDL_Time") public long access_time()

    • access_time

      public SDL_PathInfo access_time(@NativeType("SDL_Time") 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