Top Description Inners Fields Constructors Methods
org.lwjgl.util.lmdb

public Class MDBVal

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

Generic structure used for passing keys and data in and out of the database.

Values returned from the database are valid only until a subsequent update operation, or the end of the transaction. Do not modify or free them, they commonly point into the database itself.

Key sizes must be between 1 and env_get_maxkeysize inclusive. The same applies to data sizes in databases with the DUPSORT flag. Other data items can in theory be from 0 to 0xffffffff bytes long.

Layout


struct MDB_val {
    size_t mv_size;
    void * mv_data;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
MDBVal.Buffer

An array of MDBVal structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
MV_DATA

The struct member offsets.

public static final int
MV_SIZE

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
MDBVal(long address, ByteBuffer container)

public
MDBVal(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static MDBVal
calloc()

Returns a new MDBVal instance allocated with memCalloc.

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

Returns a new MDBVal.Buffer instance allocated with memCalloc.

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

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

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

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

public static MDBVal
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static MDBVal
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static MDBVal.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static MDBVal.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected MDBVal
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 MDBVal
create()

Returns a new MDBVal instance allocated with BufferUtils.

public static MDBVal
create(long address)

Returns a new MDBVal instance for the specified memory address.

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

Returns a new MDBVal.Buffer instance allocated with BufferUtils.

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

Create a MDBVal.Buffer instance at the specified memory.

public static MDBVal
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static MDBVal
malloc()

Returns a new MDBVal instance allocated with memAlloc.

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

Returns a new MDBVal.Buffer instance allocated with memAlloc.

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

Returns a new MDBVal instance allocated on the specified MemoryStack.

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

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

public static MDBVal
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static MDBVal
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static MDBVal.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static MDBVal.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public ByteBuffer
mv_data()

Address of the data item.

public MDBVal
mv_data(ByteBuffer value)

Sets the address of the specified ByteBuffer to the mv_data field.

public long
mv_size()

Size of the data item.

public MDBVal
mv_size(long value)

Sets the specified value to the mv_size field.

public static ByteBuffer
nmv_data(long struct)

Unsafe version of mv_data.

public static void
nmv_data(long struct, ByteBuffer value)

Unsafe version of mv_data.

public static long
nmv_size(long struct)

Unsafe version of mv_size.

public static void
nmv_size(long struct, long value)

Sets the specified value to the mv_size field of the specified struct.

public MDBVal
set(long mv_size, ByteBuffer mv_data)

Initializes this struct with the specified values.

public MDBVal

Returns:

this struct
set
(MDBVal
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.

MV_DATAback to summary
public static final int MV_DATA

The struct member offsets.

MV_SIZEback to summary
public static final int MV_SIZE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

MDBValback to summary
protected MDBVal(long address, ByteBuffer container)
MDBValback to summary
public MDBVal(ByteBuffer container)

Creates a MDBVal 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 MDBVal calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static MDBVal calloc(MemoryStack stack)

Returns a new MDBVal 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 MDBVal.Buffer calloc(int capacity, MemoryStack stack)

Returns a new MDBVal.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

callocStackback to summary
public static MDBVal callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static MDBVal callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static MDBVal.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static MDBVal.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
createback to summary
protected MDBVal 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 MDBVal create()

Returns a new MDBVal instance allocated with BufferUtils.

createback to summary
public static MDBVal create(long address)

Returns a new MDBVal instance for the specified memory address.

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

Returns a new MDBVal.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a MDBVal.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static MDBVal createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static MDBVal malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static MDBVal malloc(MemoryStack stack)

Returns a new MDBVal instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static MDBVal mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static MDBVal mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static MDBVal.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static MDBVal.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mv_databack to summary
public ByteBuffer mv_data()

Address of the data item.

Annotations
@Nullable
@NativeType:void *
mv_databack to summary
public MDBVal mv_data(ByteBuffer value)

Sets the address of the specified ByteBuffer to the mv_data field.

mv_sizeback to summary
public long mv_size()

Size of the data item.

Annotations
@NativeType:size_t
mv_sizeback to summary
public MDBVal mv_size(long value)

Sets the specified value to the mv_size field.

nmv_databack to summary
public static ByteBuffer nmv_data(long struct)

Unsafe version of mv_data.

Annotations
@Nullable
nmv_databack to summary
public static void nmv_data(long struct, ByteBuffer value)

Unsafe version of mv_data.

nmv_sizeback to summary
public static long nmv_size(long struct)

Unsafe version of mv_size.

nmv_sizeback to summary
public static void nmv_size(long struct, long value)

Sets the specified value to the mv_size field of the specified struct.

setback to summary
public MDBVal set(long mv_size, ByteBuffer mv_data)

Initializes this struct with the specified values.

setback to summary
public MDBVal set(MDBVal src)

Copies the specified struct data to this struct.

Parameters
src:MDBVal

the source struct

Returns:MDBVal

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.util.lmdb back to summary

public Class MDBVal.Buffer

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

An array of MDBVal structs.

Field Summary

Modifier and TypeField and Description
private static final MDBVal

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new MDBVal.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
protected MDBVal
public ByteBuffer

Returns:

a ByteBuffer view of the data pointed to by the MDBVal#mv_data field.
mv_data
()

public MDBVal.Buffer
mv_data(ByteBuffer value)

Sets the address of the specified ByteBuffer to the MDBVal#mv_data field.

public long

Returns:

the value of the MDBVal#mv_size field.
mv_size
()

public MDBVal.Buffer
mv_size(long value)

Sets the specified value to the MDBVal#mv_size field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final MDBVal ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new MDBVal.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 MDBVal#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

getElementFactoryback to summary
protected MDBVal getElementFactory()

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

Annotations
@Override
mv_databack to summary
public ByteBuffer mv_data()
Returns:ByteBuffer

a ByteBuffer view of the data pointed to by the MDBVal#mv_data field.

Annotations
@Nullable
@NativeType:void *
mv_databack to summary
public MDBVal.Buffer mv_data(ByteBuffer value)

Sets the address of the specified ByteBuffer to the MDBVal#mv_data field.

mv_sizeback to summary
public long mv_size()
Returns:long

the value of the MDBVal#mv_size field.

Annotations
@NativeType:size_t
mv_sizeback to summary
public MDBVal.Buffer mv_size(long value)

Sets the specified value to the MDBVal#mv_size field.

selfback to summary
protected MDBVal.Buffer self()

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

Annotations
@Override