Gets the address of a given segment as a number.

Checks if an object is a memory address.

nil is considered an address.

The alignment in bytes of the given type.

Allocates size bytes.

If an arena is provided, the allocation will be reclaimed when it is closed.

Allocates a memory segment for the given type.

Allocates size bytes using the allocator.

Constructs a SegmentAllocator from the given Arena.

This is primarily used when working with unwrapped downcall functions. When a downcall function returns a non-primitive type, it must be provided with an allocator.

Dereferences an address into a memory segment associated with the arena (default global).

Constructs a new memory arena that is managed by the garbage collector.

The arena may be shared across threads, and all resources created with it will be cleaned up at the same time, when all references have been collected.

This type of arena cannot be closed, and therefore should not be created in a with-open clause.

The big-endian ByteOrder.

See little-endian, native-endian.

The MemoryLayout for a byte in native-endian ByteOrder.

Gets the layout object for a given type.

If a type is primitive it will return the appropriate primitive layout (see c-prim-layout).

Otherwise, it should return a GroupLayout for the given type.

The MemoryLayout for a c-sized char in native-endian ByteOrder.

Clones the content of segment into a new segment of the same size.

Constructs a new arena for use only in this thread.

The memory allocated within this arena is cheap to allocate, like a native stack.

The memory allocated within this arena will be cleared once it is closed, so it is usually a good idea to create it in a with-open clause.

Copies the content to dest from src.

Returns dest.

Defines a type alias from new-type to aliased-type.

This creates needed serialization and deserialization implementations for the aliased type.

Deserializes an arbitrary type.

For types which have a primitive representation, this deserializes the primitive representation. For types which do not, this deserializes out of a segment.

Deserializes a primitive object into a Clojure data structure.

This is intended for use with types that are returned as a primitive but which need additional processing before they can be returned.

Deserializes the given segment into a Clojure data structure.

For types that serialize to primitives, a default implementation will deserialize the primitive before calling deserialize*.

The alignment in bytes of a c-sized double.

The MemoryLayout for a c-sized double in native-endian ByteOrder.

The size in bytes of a c-sized double.

The alignment in bytes of a c-sized float.

The MemoryLayout for a c-sized float in native-endian ByteOrder.

The size in bytes of a c-sized float.

Constructs the global arena, which will never reclaim its resources.

This arena may be shared across threads, but is intended mainly in cases where memory is allocated with alloc but is either never freed or whose management is relinquished to a native library, such as when returned from a callback.

The alignment in bytes of a c-sized int.

The MemoryLayout for a c-sized int in native-endian ByteOrder.

The size in bytes of a c-sized int.

Gets the Java class to an argument of this type for a method handle.

If a type serializes to a primitive it returns return a Java primitive type. Otherwise, it returns MemorySegment.

Map of primitive type names to the Java types for a method handle.

The little-endian ByteOrder.

See big-endian, native-endian

The alignment in bytes of a c-sized long.

The MemoryLayout for a c-sized long in native-endian ByteOrder.

The size in bytes of a c-sized long.

The ByteOrder for the native endianness of the current hardware.

See big-endian, little-endian.

The NULL pointer object.

While this object is safe to pass to functions which serialize to a pointer, it’s generally encouraged to simply pass nil. This value primarily exists to make it easier to write custom types with a primitive pointer representation.

Checks if a memory address is null.

The alignment in bytes of a c-sized pointer.

The MemoryLayout for a native pointer in native-endian ByteOrder.

The size in bytes of a c-sized pointer.

Gets the primitive type that is used to pass as an argument for the type.

This is for objects which are passed to native functions as primitive types, but which need additional logic to be performed during serialization and deserialization.

Implementations of this method should take into account that type arguments may not always be evaluated before passing to this function.

Returns nil for any type which does not have a primitive representation.

A set of all primitive types.

A predicate to determine if a given type is primitive.

Reads an address from the segment, at an optional offset, wrapped in a MemorySegment.

Reads a byte from the segment, at an optional offset.

Reads a char from the segment, at an optional offset.

Reads a double from the segment, at an optional offset.

If byte-order is not provided, it defaults to native-endian.

Reads a float from the segment, at an optional offset.

If byte-order is not provided, it defaults to native-endian.

Reads a int from the segment, at an optional offset.

If byte-order is not provided, it defaults to native-endian.

Reads a long from the segment, at an optional offset.

If byte-order is not provided, it defaults to native-endian.

Reads a short from the segment, at an optional offset.

If byte-order is not provided, it defaults to native-endian.

Reinterprets the segment as having the passed size.

If arena is passed, the scope of the segment is associated with the arena, as well as its access constraints. If cleanup is passed, it will be a 1-argument function of a fresh memory segment backed by the same memory as the returned segment which should perform any required cleanup operations. It will be called when the arena is closed.

Constructs a lazy sequence of type elements deserialized from segment.

Serializes an arbitrary type.

For types which have a primitive representation, this serializes into that representation. For types which do not, it allocates a new segment and serializes into that.

Constructs a serialized version of the obj and returns it.

Any new allocations made during the serialization should be tied to the given arena, except in extenuating circumstances.

This method should only be implemented for types that serialize to primitives.

Writes a serialized version of the obj to the given segment.

Any new allocations made during the serialization should be tied to the given arena, except in extenuating circumstances.

This method should be implemented for any type which does not override c-layout.

For any other type, this will serialize it as serialize* before writing the result value into the segment.

Constructs a new shared memory arena.

This arena can be shared across threads and memory allocated in it will only be cleaned up once any thread accessing the arena closes it.

The alignment in bytes of a c-sized short.

The MemoryLayout for a c-sized short in native-endian ByteOrder.

The size in bytes of a c-sized short.

The size in bytes of the given type.

Get a slice over the segment with the given offset.

Constructs a lazy seq of size-length memory segments, sliced from segment.

Writes the address of the MemorySegment value to the segment, at an optional offset.

Writes a byte to the segment, at an optional offset.

Writes a char to the segment, at an optional offset.

Writes a double to the segment, at an optional offset.

If byte-order is not provided, it defaults to native-endian.

Writes a float to the segment, at an optional offset.

If byte-order is not provided, it defaults to native-endian.

Writes a int to the segment, at an optional offset.

If byte-order is not provided, it defaults to native-endian.

Writes a long to the segment, at an optional offset.

If byte-order is not provided, it defaults to native-endian.

Writes a short to the segment, at an optional offset.

If byte-order is not provided, it defaults to native-endian.