Top Description Inners Fields Constructors Methods
org.lwjgl.system.linux

public Class OpenHow

extends Struct<OpenHow>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Annotations
@NativeType:struct open_how
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Arguments for how openat2(2) should open the target path.

If only flags and @mode are non-zero, then openat2(2) operates very similarly to openat(2).

However, unlike openat(2), unknown or invalid bits in flags result in -EINVAL rather than being silently ignored. mode must be zero unless one of FCNTL#O_CREAT, FCNTL#O_TMPFILE are set.

Layout


struct open_how {
    __u64 flags;
    __u64 mode;
    __u64 resolve;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
OpenHow.Buffer

An array of OpenHow structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
FLAGS

The struct member offsets.

public static final int
MODE

The struct member offsets.

public static final int
RESOLVE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
OpenHow(long address, ByteBuffer container)

public
OpenHow(ByteBuffer container)

Creates a OpenHow instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static OpenHow
calloc()

Returns a new OpenHow instance allocated with memCalloc.

public static OpenHow.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new OpenHow.Buffer instance allocated with memCalloc.

public static OpenHow
calloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new OpenHow instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static OpenHow.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new OpenHow.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

protected OpenHow
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static OpenHow
create()

Returns a new OpenHow instance allocated with BufferUtils.

public static OpenHow
create(long address)

Returns a new OpenHow instance for the specified memory address.

public static OpenHow.Buffer
create(int
the buffer capacity
capacity
)

Returns a new OpenHow.Buffer instance allocated with BufferUtils.

public static OpenHow.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a OpenHow.Buffer instance at the specified memory.

public static OpenHow
createSafe(long address)

Like create, but returns null if address is NULL.

public static OpenHow.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public long

Returns:

the value of the flags field.
flags
()

public OpenHow
flags(long value)

Sets the specified value to the flags field.

public static OpenHow
malloc()

Returns a new OpenHow instance allocated with memAlloc.

public static OpenHow.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new OpenHow.Buffer instance allocated with memAlloc.

public static OpenHow
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new OpenHow instance allocated on the specified MemoryStack.

public static OpenHow.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new OpenHow.Buffer instance allocated on the specified MemoryStack.

public long

Returns:

the value of the mode field.
mode
()

public OpenHow
mode(long value)

Sets the specified value to the mode field.

public static long
nflags(long struct)

Unsafe version of flags.

public static void
nflags(long struct, long value)

Unsafe version of flags.

public static long
nmode(long struct)

Unsafe version of mode.

public static void
nmode(long struct, long value)

Unsafe version of mode.

public static long
nresolve(long struct)

Unsafe version of resolve.

public static void
nresolve(long struct, long value)

Unsafe version of resolve.

public long

Returns:

the value of the resolve field.
resolve
()

public OpenHow
resolve(long value)

Sets the specified value to the resolve field.

public OpenHow
set(long flags, long mode, long resolve)

Initializes this struct with the specified values.

public OpenHow

Returns:

this struct
set
(OpenHow
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

FLAGSback to summary
public static final int FLAGS

The struct member offsets.

MODEback to summary
public static final int MODE

The struct member offsets.

RESOLVEback to summary
public static final int RESOLVE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

OpenHowback to summary
protected OpenHow(long address, ByteBuffer container)
OpenHowback to summary
public OpenHow(ByteBuffer container)

Creates a OpenHow instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.

The created instance holds a strong reference to the container object.

Method Detail

callocback to summary
public static OpenHow calloc()

Returns a new OpenHow instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static OpenHow.Buffer calloc(int capacity)

Returns a new OpenHow.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static OpenHow calloc(MemoryStack stack)

Returns a new OpenHow instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static OpenHow.Buffer calloc(int capacity, MemoryStack stack)

Returns a new OpenHow.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

createback to summary
protected OpenHow create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static OpenHow create()

Returns a new OpenHow instance allocated with BufferUtils.

createback to summary
public static OpenHow create(long address)

Returns a new OpenHow instance for the specified memory address.

createback to summary
public static OpenHow.Buffer create(int capacity)

Returns a new OpenHow.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static OpenHow.Buffer create(long address, int capacity)

Create a OpenHow.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static OpenHow createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static OpenHow.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
flagsback to summary
public long flags()
Returns:long

the value of the flags field.

Annotations
@NativeType:__u64
flagsback to summary
public OpenHow flags(long value)

Sets the specified value to the flags field.

mallocback to summary
public static OpenHow malloc()

Returns a new OpenHow instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static OpenHow.Buffer malloc(int capacity)

Returns a new OpenHow.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static OpenHow malloc(MemoryStack stack)

Returns a new OpenHow instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static OpenHow.Buffer malloc(int capacity, MemoryStack stack)

Returns a new OpenHow.Buffer instance allocated on the specified MemoryStack.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

modeback to summary
public long mode()
Returns:long

the value of the mode field.

Annotations
@NativeType:__u64
modeback to summary
public OpenHow mode(long value)

Sets the specified value to the mode field.

nflagsback to summary
public static long nflags(long struct)

Unsafe version of flags.

nflagsback to summary
public static void nflags(long struct, long value)

Unsafe version of flags.

nmodeback to summary
public static long nmode(long struct)

Unsafe version of mode.

nmodeback to summary
public static void nmode(long struct, long value)

Unsafe version of mode.

nresolveback to summary
public static long nresolve(long struct)

Unsafe version of resolve.

nresolveback to summary
public static void nresolve(long struct, long value)

Unsafe version of resolve.

resolveback to summary
public long resolve()
Returns:long

the value of the resolve field.

Annotations
@NativeType:__u64
resolveback to summary
public OpenHow resolve(long value)

Sets the specified value to the resolve field.

setback to summary
public OpenHow set(long flags, long mode, long resolve)

Initializes this struct with the specified values.

setback to summary
public OpenHow set(OpenHow src)

Copies the specified struct data to this struct.

Parameters
src:OpenHow

the source struct

Returns:OpenHow

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
org.lwjgl.system.linux back to summary

public Class OpenHow.Buffer

extends StructBuffer<OpenHow, OpenHow.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of OpenHow structs.

Field Summary

Modifier and TypeField and Description
private static final OpenHow

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new OpenHow.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public long

Returns:

the value of the flags field.
flags
()

public OpenHow.Buffer
flags(long value)

Sets the specified value to the flags field.

protected OpenHow
public long

Returns:

the value of the mode field.
mode
()

public OpenHow.Buffer
mode(long value)

Sets the specified value to the mode field.

public long

Returns:

the value of the resolve field.
resolve
()

public OpenHow.Buffer
resolve(long value)

Sets the specified value to the resolve field.

protected OpenHow.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final OpenHow ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new OpenHow.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by OpenHow#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

flagsback to summary
public long flags()
Returns:long

the value of the flags field.

Annotations
@NativeType:__u64
flagsback to summary
public OpenHow.Buffer flags(long value)

Sets the specified value to the flags field.

getElementFactoryback to summary
protected OpenHow getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
modeback to summary
public long mode()
Returns:long

the value of the mode field.

Annotations
@NativeType:__u64
modeback to summary
public OpenHow.Buffer mode(long value)

Sets the specified value to the mode field.

resolveback to summary
public long resolve()
Returns:long

the value of the resolve field.

Annotations
@NativeType:__u64
resolveback to summary
public OpenHow.Buffer resolve(long value)

Sets the specified value to the resolve field.

selfback to summary
protected OpenHow.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override