From 5c1b2d3f7cf8dac146c34d1e19fc9af83c232f5f Mon Sep 17 00:00:00 2001 From: Joshua Suskalo Date: Fri, 22 Nov 2024 10:03:28 -0500 Subject: [PATCH] Add cross-link for tagged union type mention --- docs/03-Builtin-Types.html | 2 +- docs/articles/03-Builtin-Types.md | 5 +- docs/coffi.ffi.html | 40 ++++---- docs/coffi.layout.html | 2 +- docs/coffi.mem.html | 146 +++++++++++++++--------------- 5 files changed, 98 insertions(+), 97 deletions(-) diff --git a/docs/03-Builtin-Types.html b/docs/03-Builtin-Types.html index 39cdd2f..375a2b2 100644 --- a/docs/03-Builtin-Types.html +++ b/docs/03-Builtin-Types.html @@ -15,7 +15,7 @@ (float? %) ::mem/float (double? %) ::mem/double)] -

This is a minimal union in coffi. If the :dispatch keyword argument is not passed, then the union cannot be serialized, as coffi would not know which type to serialize the values as. In the example with a tagged union, a dispatch function was not provided because the type was only used for the native layout.

+

This is a minimal union in coffi. If the :dispatch keyword argument is not passed, then the union cannot be serialized, as coffi would not know which type to serialize the values as. In the example with a tagged union, a dispatch function was not provided because the type was only used for the native layout.

In addition to a dispatch function, when serializing a union an extract function may also be provided. In the case of the value in the tagged union from before, it could be represented for serialization purposes like so:

[::mem/union
  #{::mem/int ::mem/c-string}
diff --git a/docs/articles/03-Builtin-Types.md b/docs/articles/03-Builtin-Types.md
index 7b9ecdd..5de1e29 100644
--- a/docs/articles/03-Builtin-Types.md
+++ b/docs/articles/03-Builtin-Types.md
@@ -26,8 +26,9 @@ without external information.
 
 This is a minimal union in coffi. If the `:dispatch` keyword argument is not
 passed, then the union cannot be serialized, as coffi would not know which type
-to serialize the values as. In the example with a tagged union, a dispatch
-function was not provided because the type was only used for the native layout.
+to serialize the values as. In [the example with a tagged
+union](04-Custom-Types.md#tagged-union), a dispatch function was not provided
+because the type was only used for the native layout.
 
 In addition to a dispatch function, when serializing a union an extract function
 may also be provided. In the case of the value in the tagged union from before,
diff --git a/docs/coffi.ffi.html b/docs/coffi.ffi.html
index c133e8f..a46fe82 100644
--- a/docs/coffi.ffi.html
+++ b/docs/coffi.ffi.html
@@ -4,38 +4,38 @@
 
cfn
(cfn symbol args ret)
Constructs a Clojure function to call the native function referenced by symbol.

 
The function returned will serialize any passed arguments into the args types, and deserialize the return to the ret type.

 
If your args and ret are constants, then it is more efficient to call make-downcall followed by make-serde-wrapper because the latter has an inline definition which will result in less overhead from serdes.

-
view source
const
(const symbol-or-addr type)
Gets the value of a constant stored in symbol-or-addr.

-
view source
defcfn
macro
(defcfn name docstring? attr-map? symbol arg-types ret-type)(defcfn name docstring? attr-map? symbol arg-types ret-type native-fn & fn-tail)
Defines a Clojure function which maps to a native function.

+
view source
const
(const symbol-or-addr type)
Gets the value of a constant stored in symbol-or-addr.

+
view source
defcfn
macro
(defcfn name docstring? attr-map? symbol arg-types ret-type)(defcfn name docstring? attr-map? symbol arg-types ret-type native-fn & fn-tail)
Defines a Clojure function which maps to a native function.

 
name is the symbol naming the resulting var. symbol is a symbol or string naming the library symbol to link against. arg-types is a vector of qualified keywords representing the argument types. ret-type is a single qualified keyword representing the return type. fn-tail is the body of the function (potentially with multiple arities) which wraps the native one. Inside the function, native-fn is bound to a function that will serialize its arguments, call the native function, and deserialize its return type. If any body is present, you must call this function in order to call the native code.

 
If no fn-tail is provided, then the resulting function will simply serialize the arguments according to arg-types, call the native function, and deserialize the return value.

 
The number of args in the fn-tail need not match the number of arg-types for the native function. It need only call the native wrapper function with the correct arguments.

 
See serialize, deserialize, make-downcall.

-
view source
defconst
macro
(defconst symbol docstring? symbol-or-addr type)
Defines a var named by symbol to be the value of the given type from symbol-or-addr.

-
view source
defvar
macro
(defvar symbol docstring? symbol-or-addr type)
Defines a var named by symbol to be a reference to the native memory from symbol-or-addr.

-
view source
ensure-symbol
(ensure-symbol symbol-or-addr)
Returns the argument if it is a MemorySegment, otherwise calls find-symbol on it.

-
view source
find-symbol
(find-symbol sym)
Gets the MemorySegment of a symbol from the loaded libraries.

-
view source
freset!
(freset! static-var newval)
Sets the value of static-var to newval, running it through serialize.

-
view source
fswap!
(fswap! static-var f & args)
Non-atomically runs the function f over the value stored in static-var.

+
view source
defconst
macro
(defconst symbol docstring? symbol-or-addr type)
Defines a var named by symbol to be the value of the given type from symbol-or-addr.

+
view source
defvar
macro
(defvar symbol docstring? symbol-or-addr type)
Defines a var named by symbol to be a reference to the native memory from symbol-or-addr.

+
view source
ensure-symbol
(ensure-symbol symbol-or-addr)
Returns the argument if it is a MemorySegment, otherwise calls find-symbol on it.

+
view source
find-symbol
(find-symbol sym)
Gets the MemorySegment of a symbol from the loaded libraries.

+
view source
freset!
(freset! static-var newval)
Sets the value of static-var to newval, running it through serialize.

+
view source
fswap!
(fswap! static-var f & args)
Non-atomically runs the function f over the value stored in static-var.

 
The value is deserialized before passing it to f, and serialized before putting the value into static-var.

-
view source
load-library
(load-library path)
Loads the library at path.

-
view source
load-system-library
(load-system-library libname)
Loads the library named libname from the system’s load path.

-
view source
make-downcall
(make-downcall symbol-or-addr args ret)
Constructs a downcall function reference to symbol-or-addr with the given args and ret types.

+
view source
load-library
(load-library path)
Loads the library at path.

+
view source
load-system-library
(load-system-library libname)
Loads the library named libname from the system’s load path.

+
view source
make-downcall
(make-downcall symbol-or-addr args ret)
Constructs a downcall function reference to symbol-or-addr with the given args and ret types.

 
The function returned takes only arguments whose types match exactly the java-layout for that type, and returns an argument with exactly the java-layout of the ret type. This function will perform no serialization or deserialization of arguments or the return type.

 
If the ret type is non-primitive, then the returned function will take a first argument of a SegmentAllocator.

-
view source
make-serde-varargs-wrapper
(make-serde-varargs-wrapper varargs-factory required-args ret-type)
Constructs a wrapper function for the varargs-factory which produces functions that serialize the arguments and deserialize the return value.

-
view source
make-serde-wrapper
(make-serde-wrapper downcall arg-types ret-type)
Constructs a wrapper function for the downcall which serializes the arguments and deserializes the return value.

-
view source
make-varargs-factory
(make-varargs-factory symbol required-args ret)
Returns a function for constructing downcalls with additional types for arguments.

+
view source
make-serde-varargs-wrapper
(make-serde-varargs-wrapper varargs-factory required-args ret-type)
Constructs a wrapper function for the varargs-factory which produces functions that serialize the arguments and deserialize the return value.

+
view source
make-serde-wrapper
(make-serde-wrapper downcall arg-types ret-type)
Constructs a wrapper function for the downcall which serializes the arguments and deserializes the return value.

+
view source
make-varargs-factory
(make-varargs-factory symbol required-args ret)
Returns a function for constructing downcalls with additional types for arguments.

 
The required-args are the types of the first arguments passed to the downcall handle, and the values passed to the returned function are only the varargs types.

 
The returned function is memoized, so that only one downcall function will be generated per combination of argument types.

 
See make-downcall.

-
view source
reify-libspec
(reify-libspec libspec)
Loads all the symbols specified in the libspec.

+
view source
reify-libspec
(reify-libspec libspec)
Loads all the symbols specified in the libspec.

 
The value of each key of the passed map is transformed as by reify-symbolspec.

-
view source
reify-symbolspec
multimethod
Takes a spec for a symbol reference and returns a live value for that type.

-
view source
static-variable
(static-variable symbol-or-addr type)
Constructs a reference to a mutable value stored in symbol-or-addr.

+
view source
reify-symbolspec
multimethod
Takes a spec for a symbol reference and returns a live value for that type.

+
view source
static-variable
(static-variable symbol-or-addr type)
Constructs a reference to a mutable value stored in symbol-or-addr.

 
The returned value can be dereferenced, and has metadata.

 
See freset!, fswap!.

-
view source
static-variable-segment
(static-variable-segment static-var)
Gets the backing MemorySegment from static-var.

+
view source
static-variable-segment
(static-variable-segment static-var)
Gets the backing MemorySegment from static-var.

 
This is primarily useful when you need to pass the static variable’s address to a native function which takes an Addressable.

-
view source
vacfn-factory
(vacfn-factory symbol required-args ret)
Constructs a varargs factory to call the native function referenced by symbol.

+
view source
vacfn-factory
(vacfn-factory symbol required-args ret)
Constructs a varargs factory to call the native function referenced by symbol.

 
The function returned takes any number of type arguments and returns a specialized Clojure function for calling the native function with those arguments.

-
view source

\ No newline at end of file
+
view source

\ No newline at end of file
diff --git a/docs/coffi.layout.html b/docs/coffi.layout.html
index 26fdffe..9725c62 100644
--- a/docs/coffi.layout.html
+++ b/docs/coffi.layout.html
@@ -3,4 +3,4 @@
 coffi.layout documentation
Project
Topics
Namespaces
Public Vars
coffi.layout
Functions for adjusting the layout of structs.

 
with-c-layout
(with-c-layout struct-spec)
Forces a struct specification to C layout rules.

 
This will add padding fields between fields to match C alignment requirements.

-
view source

\ No newline at end of file
+
view source

\ No newline at end of file
diff --git a/docs/coffi.mem.html b/docs/coffi.mem.html
index 1189d19..e39fb9d 100644
--- a/docs/coffi.mem.html
+++ b/docs/coffi.mem.html
@@ -5,117 +5,117 @@
 
If the native representation of the type is a primitive (whether or not other data beyond the primitive is associated with it, as e.g. a pointer), then primitive-type must be overriden to return which primitive type it is serialized as, then serialize* and deserialize* should be overriden.

 
If the native representation of the type is a composite type, like a union, struct, or array, then c-layout must be overriden to return the native layout of the type, and serialize-into and deserialize-from should be overriden to allow marshaling values of the type into and out of memory segments.

 
address-of
(address-of addressable)
Gets the address of a given segment as a number.

-
view source
address?
(address? addr)
Checks if an object is a memory address.

+
view source
address?
(address? addr)
Checks if an object is a memory address.

 
nil is considered an address.

-
view source
align-of
(align-of type)
The alignment in bytes of the given type.

-
view source
alloc
(alloc size)(alloc size arena)(alloc size alignment arena)
Allocates size bytes.

+
view source
align-of
(align-of type)
The alignment in bytes of the given type.

+
view source
alloc
(alloc size)(alloc size arena)(alloc size alignment arena)
Allocates size bytes.

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

-
view source
alloc-instance
(alloc-instance type)(alloc-instance type arena)
Allocates a memory segment for the given type.

-
view source
alloc-with
(alloc-with allocator size)(alloc-with allocator size alignment)
Allocates size bytes using the allocator.

-
view source
arena-allocator
(arena-allocator arena)
Constructs a SegmentAllocator from the given Arena.

+
view source
alloc-instance
(alloc-instance type)(alloc-instance type arena)
Allocates a memory segment for the given type.

+
view source
alloc-with
(alloc-with allocator size)(alloc-with allocator size alignment)
Allocates size bytes using the allocator.

+
view source
arena-allocator
(arena-allocator arena)
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.

-
view source
as-segment
(as-segment address)(as-segment address size)(as-segment address size arena)(as-segment address size arena cleanup)
Dereferences an address into a memory segment associated with the arena (default global).

-
view source
auto-arena
(auto-arena)
Constructs a new memory arena that is managed by the garbage collector.

+
view source
as-segment
(as-segment address)(as-segment address size)(as-segment address size arena)(as-segment address size arena cleanup)
Dereferences an address into a memory segment associated with the arena (default global).

+
view source
auto-arena
(auto-arena)
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.

-
view source
big-endian
The big-endian ByteOrder.

+
view source
big-endian
The big-endian ByteOrder.

 
See little-endian, native-endian.

-
view source
byte-layout
The MemoryLayout for a byte in native-endian ByteOrder.

-
view source
c-layout
multimethod
Gets the layout object for a given type.

+
view source
byte-layout
The MemoryLayout for a byte in native-endian ByteOrder.

+
view source
c-layout
multimethod
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.

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

-
view source
clone-segment
(clone-segment segment)(clone-segment segment arena)
Clones the content of segment into a new segment of the same size.

-
view source
confined-arena
(confined-arena)
Constructs a new arena for use only in this thread.

+
view source
char-layout
The MemoryLayout for a c-sized char in native-endian ByteOrder.

+
view source
clone-segment
(clone-segment segment)(clone-segment segment arena)
Clones the content of segment into a new segment of the same size.

+
view source
confined-arena
(confined-arena)
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.

-
view source
copy-segment
(copy-segment dest src)
Copies the content to dest from src.

+
view source
copy-segment
(copy-segment dest src)
Copies the content to dest from src.

 
Returns dest.

-
view source
defalias
macro
(defalias new-type aliased-type)
Defines a type alias from new-type to aliased-type.

+
view source
defalias
macro
(defalias new-type aliased-type)
Defines a type alias from new-type to aliased-type.

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

-
view source
deserialize
(deserialize obj type)
Deserializes an arbitrary type.

+
view source
deserialize
(deserialize obj 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.

-
view source
deserialize*
multimethod
Deserializes a primitive object into a Clojure data structure.

+
view source
deserialize*
multimethod
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.

-
view source
deserialize-from
multimethod
Deserializes the given segment into a Clojure data structure.

+
view source
deserialize-from
multimethod
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*.

-
view source
double-alignment
The alignment in bytes of a c-sized double.

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

-
view source
double-size
The size in bytes of a c-sized double.

-
view source
float-alignment
The alignment in bytes of a c-sized float.

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

-
view source
float-size
The size in bytes of a c-sized float.

-
view source
global-arena
(global-arena)
Constructs the global arena, which will never reclaim its resources.

+
view source
double-alignment
The alignment in bytes of a c-sized double.

+
view source
double-layout
The MemoryLayout for a c-sized double in native-endian ByteOrder.

+
view source
double-size
The size in bytes of a c-sized double.

+
view source
float-alignment
The alignment in bytes of a c-sized float.

+
view source
float-layout
The MemoryLayout for a c-sized float in native-endian ByteOrder.

+
view source
float-size
The size in bytes of a c-sized float.

+
view source
global-arena
(global-arena)
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.

-
view source
int-alignment
The alignment in bytes of a c-sized int.

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

-
view source
int-size
The size in bytes of a c-sized int.

-
view source
java-layout
(java-layout type)
Gets the Java class to an argument of this type for a method handle.

+
view source
int-alignment
The alignment in bytes of a c-sized int.

+
view source
int-layout
The MemoryLayout for a c-sized int in native-endian ByteOrder.

+
view source
int-size
The size in bytes of a c-sized int.

+
view source
java-layout
(java-layout type)
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.

-
view source
java-prim-layout
Map of primitive type names to the Java types for a method handle.

-
view source
little-endian
The little-endian ByteOrder.

+
view source
java-prim-layout
Map of primitive type names to the Java types for a method handle.

+
view source
little-endian
The little-endian ByteOrder.

 
See big-endian, native-endian

-
view source
long-alignment
The alignment in bytes of a c-sized long.

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

-
view source
long-size
The size in bytes of a c-sized long.

-
view source
native-endian
The ByteOrder for the native endianness of the current hardware.

+
view source
long-alignment
The alignment in bytes of a c-sized long.

+
view source
long-layout
The MemoryLayout for a c-sized long in native-endian ByteOrder.

+
view source
long-size
The size in bytes of a c-sized long.

+
view source
native-endian
The ByteOrder for the native endianness of the current hardware.

 
See big-endian, little-endian.

-
view source
null
The NULL pointer object.

+
view source
null
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.

-
view source
null?
(null? addr)
Checks if a memory address is null.

-
view source
pointer-alignment
The alignment in bytes of a c-sized pointer.

-
view source
pointer-layout
The MemoryLayout for a native pointer in native-endian ByteOrder.

-
view source
pointer-size
The size in bytes of a c-sized pointer.

-
view source
primitive-type
multimethod
Gets the primitive type that is used to pass as an argument for the type.

+
view source
null?
(null? addr)
Checks if a memory address is null.

+
view source
pointer-alignment
The alignment in bytes of a c-sized pointer.

+
view source
pointer-layout
The MemoryLayout for a native pointer in native-endian ByteOrder.

+
view source
pointer-size
The size in bytes of a c-sized pointer.

+
view source
primitive-type
multimethod
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.

-
view source
primitive-types
A set of all primitive types.

-
view source
primitive?
(primitive? type)
A predicate to determine if a given type is primitive.

-
view source
read-address
(read-address segment)(read-address segment offset)
Reads an address from the segment, at an optional offset, wrapped in a MemorySegment.

-
view source
read-byte
(read-byte segment)(read-byte segment offset)
Reads a byte from the segment, at an optional offset.

-
view source
read-char
(read-char segment)(read-char segment offset)
Reads a char from the segment, at an optional offset.

-
view source
read-double
(read-double segment)(read-double segment offset)(read-double segment offset byte-order)
Reads a double from the segment, at an optional offset.

+
view source
primitive-types
A set of all primitive types.

+
view source
primitive?
(primitive? type)
A predicate to determine if a given type is primitive.

+
view source
read-address
(read-address segment)(read-address segment offset)
Reads an address from the segment, at an optional offset, wrapped in a MemorySegment.

+
view source
read-byte
(read-byte segment)(read-byte segment offset)
Reads a byte from the segment, at an optional offset.

+
view source
read-char
(read-char segment)(read-char segment offset)
Reads a char from the segment, at an optional offset.

+
view source
read-double
(read-double segment)(read-double segment offset)(read-double segment offset byte-order)
Reads a double from the segment, at an optional offset.

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

-
view source
read-float
(read-float segment)(read-float segment offset)(read-float segment offset byte-order)
Reads a float from the segment, at an optional offset.

+
view source
read-float
(read-float segment)(read-float segment offset)(read-float segment offset byte-order)
Reads a float from the segment, at an optional offset.

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

-
view source
read-int
(read-int segment)(read-int segment offset)(read-int segment offset byte-order)
Reads a int from the segment, at an optional offset.

+
view source
read-int
(read-int segment)(read-int segment offset)(read-int segment offset byte-order)
Reads a int from the segment, at an optional offset.

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

-
view source
read-long
(read-long segment)(read-long segment offset)(read-long segment offset byte-order)
Reads a long from the segment, at an optional offset.

+
view source
read-long
(read-long segment)(read-long segment offset)(read-long segment offset byte-order)
Reads a long from the segment, at an optional offset.

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

-
view source
read-short
(read-short segment)(read-short segment offset)(read-short segment offset byte-order)
Reads a short from the segment, at an optional offset.

+
view source
read-short
(read-short segment)(read-short segment offset)(read-short segment offset byte-order)
Reads a short from the segment, at an optional offset.

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

-
view source
reinterpret
(reinterpret segment size)(reinterpret segment size arena)(reinterpret segment size arena cleanup)
Reinterprets the segment as having the passed size.

+
view source
reinterpret
(reinterpret segment size)(reinterpret segment size arena)(reinterpret segment size arena cleanup)
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.

-
view source
seq-of
(seq-of type segment)
Constructs a lazy sequence of type elements deserialized from segment.

-
view source
serialize
(serialize obj type)(serialize obj type arena)
Serializes an arbitrary type.

+
view source
seq-of
(seq-of type segment)
Constructs a lazy sequence of type elements deserialized from segment.

+
view source
serialize
(serialize obj type)(serialize obj type arena)
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.

-
view source
serialize*
multimethod
Constructs a serialized version of the obj and returns it.

+
view source
serialize*
multimethod
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.

-
view source
serialize-into
multimethod
Writes a serialized version of the obj to the given segment.

+
view source
serialize-into
multimethod
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.

-
view source
shared-arena
(shared-arena)
Constructs a new shared memory arena.

+
view source
shared-arena
(shared-arena)
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.

-
view source
short-alignment
The alignment in bytes of a c-sized short.

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

-
view source
short-size
The size in bytes of a c-sized short.

-
view source
size-of
(size-of type)
The size in bytes of the given type.

-
view source
slice
(slice segment offset)(slice segment offset size)
Get a slice over the segment with the given offset.

-
view source
slice-segments
(slice-segments segment size)
Constructs a lazy seq of size-length memory segments, sliced from segment.

-
view source
write-address
(write-address segment value)(write-address segment offset value)
Writes the address of the MemorySegment value to the segment, at an optional offset.

-
view source
write-byte
(write-byte segment value)(write-byte segment offset value)
Writes a byte to the segment, at an optional offset.

-
view source
write-char
(write-char segment value)(write-char segment offset value)
Writes a char to the segment, at an optional offset.

-
view source
write-double
(write-double segment value)(write-double segment offset value)(write-double segment offset byte-order value)
Writes a double to the segment, at an optional offset.

+
view source
short-alignment
The alignment in bytes of a c-sized short.

+
view source
short-layout
The MemoryLayout for a c-sized short in native-endian ByteOrder.

+
view source
short-size
The size in bytes of a c-sized short.

+
view source
size-of
(size-of type)
The size in bytes of the given type.

+
view source
slice
(slice segment offset)(slice segment offset size)
Get a slice over the segment with the given offset.

+
view source
slice-segments
(slice-segments segment size)
Constructs a lazy seq of size-length memory segments, sliced from segment.

+
view source
write-address
(write-address segment value)(write-address segment offset value)
Writes the address of the MemorySegment value to the segment, at an optional offset.

+
view source
write-byte
(write-byte segment value)(write-byte segment offset value)
Writes a byte to the segment, at an optional offset.

+
view source
write-char
(write-char segment value)(write-char segment offset value)
Writes a char to the segment, at an optional offset.

+
view source
write-double
(write-double segment value)(write-double segment offset value)(write-double segment offset byte-order value)
Writes a double to the segment, at an optional offset.

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

-
view source
write-float
(write-float segment value)(write-float segment offset value)(write-float segment offset byte-order value)
Writes a float to the segment, at an optional offset.

+
view source
write-float
(write-float segment value)(write-float segment offset value)(write-float segment offset byte-order value)
Writes a float to the segment, at an optional offset.

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

-
view source
write-int
(write-int segment value)(write-int segment offset value)(write-int segment offset byte-order value)
Writes a int to the segment, at an optional offset.

+
view source
write-int
(write-int segment value)(write-int segment offset value)(write-int segment offset byte-order value)
Writes a int to the segment, at an optional offset.

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

-
view source
write-long
(write-long segment value)(write-long segment offset value)(write-long segment offset byte-order value)
Writes a long to the segment, at an optional offset.

+
view source
write-long
(write-long segment value)(write-long segment offset value)(write-long segment offset byte-order value)
Writes a long to the segment, at an optional offset.

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

-
view source
write-short
(write-short segment value)(write-short segment offset value)(write-short segment offset byte-order value)
Writes a short to the segment, at an optional offset.

+
view source
write-short
(write-short segment value)(write-short segment offset value)(write-short segment offset byte-order value)
Writes a short to the segment, at an optional offset.

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

-
view source

\ No newline at end of file
+
view source

\ No newline at end of file