<p>For any new type to be implemented, three multimethods must be overriden, but which three depends on the native representation of the type.</p>
<p>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 <ahref="coffi.mem.html#var-primitive-type">primitive-type</a> must be overriden to return which primitive type it is serialized as, then <ahref="coffi.mem.html#var-serialize*">serialize*</a> and <ahref="coffi.mem.html#var-deserialize*">deserialize*</a> should be overriden.</p>
<p>If the native representation of the type is a composite type, like a union, struct, or array, then <ahref="coffi.mem.html#var-c-layout">c-layout</a> must be overriden to return the native layout of the type, and <ahref="coffi.mem.html#var-serialize-into">serialize-into</a> and <ahref="coffi.mem.html#var-deserialize-from">deserialize-from</a> should be overriden to allow marshaling values of the type into and out of memory segments.</p>
<p>When writing code that manipulates a segment, it’s best practice to use <ahref="coffi.mem.html#var-with-acquired">with-acquired</a> on the <ahref="coffi.mem.html#var-segment-scope">segment-scope</a> in order to ensure it won’t be released during its manipulation.</p></div></div><divclass="public anchor"id="var-add-close-action.21"><h3>add-close-action!</h3><divclass="usage"><code>(add-close-action! scope action)</code></div><divclass="doc"><divclass="markdown"><p>Adds a 0-arity function to be run when the <code>scope</code> closes.</p></div></div><divclass="src-link"><ahref="https://github.com/IGJoshua/coffi/blob/1abc1fd779e86072f502251dec5e9c5350d2ef82/src/clj/coffi/mem.clj#L182">view source</a></div></div><divclass="public anchor"id="var-address-of"><h3>address-of</h3><divclass="usage"><code>(address-of addressable)</code></div><divclass="doc"><divclass="markdown"><p>Gets the address of a given segment.</p>
<p>This value can be used as an argument to functions which take a pointer.</p></div></div><divclass="src-link"><ahref="https://github.com/IGJoshua/coffi/blob/1abc1fd779e86072f502251dec5e9c5350d2ef82/src/clj/coffi/mem.clj#L121">view source</a></div></div><divclass="public anchor"id="var-address.3F"><h3>address?</h3><divclass="usage"><code>(address? addr)</code></div><divclass="doc"><divclass="markdown"><p>Checks if an object is a memory address.</p>
<p><code>nil</code> is considered an address.</p></div></div><divclass="src-link"><ahref="https://github.com/IGJoshua/coffi/blob/1abc1fd779e86072f502251dec5e9c5350d2ef82/src/clj/coffi/mem.clj#L133">view source</a></div></div><divclass="public anchor"id="var-alloc"><h3>alloc</h3><divclass="usage"><code>(alloc size)</code><code>(alloc size scope)</code></div><divclass="doc"><divclass="markdown"><p>Allocates <code>size</code> bytes.</p>
<p>If a <code>scope</code> is provided, the allocation will be reclaimed when it is closed.</p></div></div><divclass="src-link"><ahref="https://github.com/IGJoshua/coffi/blob/1abc1fd779e86072f502251dec5e9c5350d2ef82/src/clj/coffi/mem.clj#L86">view source</a></div></div><divclass="public anchor"id="var-alloc-instance"><h3>alloc-instance</h3><divclass="usage"><code>(alloc-instance type)</code><code>(alloc-instance type scope)</code></div><divclass="doc"><divclass="markdown"><p>Allocates a memory segment for the given <code>type</code>.</p></div></div><divclass="src-link"><ahref="https://github.com/IGJoshua/coffi/blob/1abc1fd779e86072f502251dec5e9c5350d2ef82/src/clj/coffi/mem.clj#L352">view source</a></div></div><divclass="public anchor"id="var-alloc-with"><h3>alloc-with</h3><divclass="usage"><code>(alloc-with allocator size)</code><code>(alloc-with allocator size alignment)</code></div><divclass="doc"><divclass="markdown"><p>Allocates <code>size</code> bytes using the <code>allocator</code>.</p></div></div><divclass="src-link"><ahref="https://github.com/IGJoshua/coffi/blob/1abc1fd779e86072f502251dec5e9c5350d2ef82/src/clj/coffi/mem.clj#L93">view source</a></div></div><divclass="public anchor"id="var-as-segment"><h3>as-segment</h3><divclass="usage"><code>(as-segment address size scope)</code><code>(as-segment address size scope cleanup)</code></div><divclass="doc"><divclass="markdown"><p>Dereferences an <code>address</code> into a memory segment associated with the <code>scope</code>.</p>
<p>If <code>cleanup</code> is provided, it is a 0-arity function run when the scope is closed. This can be used to register a free method for the memory, or do other cleanup in a way that doesn’t require modifying the code at the point of freeing, and allows shared or garbage collected resources to be freed correctly.</p></div></div><divclass="src-link"><ahref="https://github.com/IGJoshua/coffi/blob/1abc1fd779e86072f502251dec5e9c5350d2ef82/src/clj/coffi/mem.clj#L169">view source</a></div></div><divclass="public anchor"id="var-c-layout"><h3>c-layout</h3><h4class="type">multimethod</h4><divclass="usage"></div><divclass="doc"><divclass="markdown"><p>Gets the layout object for a given <code>type</code>.</p>
<p>Otherwise, it should return a <ahref="null">GroupLayout</a> for the given type.</p></div></div><divclass="src-link"><ahref="https://github.com/IGJoshua/coffi/blob/1abc1fd779e86072f502251dec5e9c5350d2ef82/src/clj/coffi/mem.clj#L277">view source</a></div></div><divclass="public anchor"id="var-clone-segment"><h3>clone-segment</h3><divclass="usage"><code>(clone-segment segment)</code><code>(clone-segment segment scope)</code></div><divclass="doc"><divclass="markdown"><p>Clones the content of <code>segment</code> into a new segment of the same size.</p></div></div><divclass="src-link"><ahref="https://github.com/IGJoshua/coffi/blob/1abc1fd779e86072f502251dec5e9c5350d2ef82/src/clj/coffi/mem.clj#L193">view source</a></div></div><divclass="public anchor"id="var-connected-scope"><h3>connected-scope</h3><divclass="usage"><code>(connected-scope)</code></div><divclass="doc"><divclass="markdown"><p>Constructs a new scope to reclaim all connected resources at once.</p>
<p>The scope 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.</p>
<p>This type of scope cannot be closed, and therefore should not be created in a <ahref="null">with-open</a> clause.</p></div></div><divclass="src-link"><ahref="https://github.com/IGJoshua/coffi/blob/1abc1fd779e86072f502251dec5e9c5350d2ef82/src/clj/coffi/mem.clj#L51">view source</a></div></div><divclass="public anchor"id="var-copy-segment"><h3>copy-segment</h3><divclass="usage"><code>(copy-segment dest src)</code></div><divclass="doc"><divclass="markdown"><p>Copies the content to <code>dest</code> from <code>src</code></p></div></div><divclass="src-link"><ahref="https://github.com/IGJoshua/coffi/blob/1abc1fd779e86072f502251dec5e9c5350d2ef82/src/clj/coffi/mem.clj#L187">view source</a></div></div><divclass="public anchor"id="var-defalias"><h3>defalias</h3><h4class="type">macro</h4><divclass="usage"><code>(defalias new-type aliased-type)</code></div><divclass="doc"><divclass="markdown"><p>Defines a type alias from <code>new-type</code> to <code>aliased-type</code>.</p>
<p>This creates needed serialization and deserialization implementations for the aliased type.</p></div></div><divclass="src-link"><ahref="https://github.com/IGJoshua/coffi/blob/1abc1fd779e86072f502251dec5e9c5350d2ef82/src/clj/coffi/mem.clj#L772">view source</a></div></div><divclass="public anchor"id="var-deserialize"><h3>deserialize</h3><divclass="usage"><code>(deserialize obj type)</code></div><divclass="doc"><divclass="markdown"><p>Deserializes an arbitrary type.</p>
<p>For types which have a primitive representation, this deserializes the primitive representation. For types which do not, this deserializes out of a segment.</p></div></div><divclass="src-link"><ahref="https://github.com/IGJoshua/coffi/blob/1abc1fd779e86072f502251dec5e9c5350d2ef82/src/clj/coffi/mem.clj#L629">view source</a></div></div><divclass="public anchor"id="var-deserialize*"><h3>deserialize*</h3><h4class="type">multimethod</h4><divclass="usage"></div><divclass="doc"><divclass="markdown"><p>Deserializes a primitive object into a Clojure data structure.</p>
<p>This is intended for use with types that are returned as a primitive but which need additional processing before they can be returned.</p></div></div><divclass="src-link"><ahref="https://github.com/IGJoshua/coffi/blob/1abc1fd779e86072f502251dec5e9c5350d2ef82/src/clj/coffi/mem.clj#L569">view source</a></div></div><divclass="public anchor"id="var-deserialize-from"><h3>deserialize-from</h3><h4class="type">multimethod</h4><divclass="usage"></div><divclass="doc"><divclass="markdown"><p>Deserializes the given segment into a Clojure data structure.</p>
<p>For types that serialize to primitives, a default implementation will deserialize the primitive before calling <ahref="coffi.mem.html#var-deserialize*">deserialize*</a>.</p>
<p>Implementations of this should be inside a <ahref="coffi.mem.html#var-with-acquired">with-acquired</a> block for the the <code>segment</code>’s scope if they perform multiple memory operations.</p></div></div><divclass="src-link"><ahref="https://github.com/IGJoshua/coffi/blob/1abc1fd779e86072f502251dec5e9c5350d2ef82/src/clj/coffi/mem.clj#L508">view source</a></div></div><divclass="public anchor"id="var-global-scope"><h3>global-scope</h3><divclass="usage"><code>(global-scope)</code></div><divclass="doc"><divclass="markdown"><p>Constructs the global scope, which will never reclaim its resources.</p>
<p>This scope may be shared across threads, but is intended mainly in cases where memory is allocated with <ahref="coffi.mem.html#var-alloc">alloc</a> but is either never freed or whose management is relinquished to a native library, such as when returned from a callback.</p></div></div><divclass="src-link"><ahref="https://github.com/IGJoshua/coffi/blob/1abc1fd779e86072f502251dec5e9c5350d2ef82/src/clj/coffi/mem.clj#L62">view source</a></div></div><divclass="public anchor"id="var-java-layout"><h3>java-layout</h3><divclass="usage"><code>(java-layout type)</code></div><divclass="doc"><divclass="markdown"><p>Gets the Java class to an argument of this type for a method handle.</p>
<p>If a type serializes to a primitive it returns return a Java primitive type. Otherwise, it returns <ahref="null">MemorySegment</a>.</p></div></div><divclass="src-link"><ahref="https://github.com/IGJoshua/coffi/blob/1abc1fd779e86072f502251dec5e9c5350d2ef82/src/clj/coffi/mem.clj#L339">view source</a></div></div><divclass="public anchor"id="var-java-prim-layout"><h3>java-prim-layout</h3><divclass="usage"></div><divclass="doc"><divclass="markdown"><p>Map of primitive type names to the Java types for a method handle.</p></div></div><divclass="src-link"><ahref="https://github.com/IGJoshua/coffi/blob/1abc1fd779e86072f502251dec5e9c5350d2ef82/src/clj/coffi/mem.clj#L326">view source</a></div></div><divclass="public anchor"id="var-null.3F"><h3>null?</h3><divclass="usage"><code>(null? addr)</code></div><divclass="doc"><divclass="markdown"><p>Checks if a memory address is null.</p></div></div><divclass="src-link"><ahref="https://github.com/IGJoshua/coffi/blob/1abc1fd779e86072f502251dec5e9c5350d2ef82/src/clj/coffi/mem.clj#L128">view source</a></div></div><divclass="public anchor"id="var-primitive-type"><h3>primitive-type</h3><h4class="type">multimethod</h4><divclass="usage"></div><divclass="doc"><divclass="markdown"><p>Gets the primitive type that is used to pass as an argument for the <code>type</code>.</p>
<p>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.</p>
<p>Implementations of this method should take into account that type arguments may not always be evaluated before passing to this function.</p>
<p>Returns nil for any type which does not have a primitive representation.</p></div></div><divclass="src-link"><ahref="https://github.com/IGJoshua/coffi/blob/1abc1fd779e86072f502251dec5e9c5350d2ef82/src/clj/coffi/mem.clj#L220">view source</a></div></div><divclass="public anchor"id="var-primitive.3F"><h3>primitive?</h3><divclass="usage"></div><divclass="doc"><divclass="markdown"><p>A set of all primitive types.</p></div></div><divclass="src-link"><ahref="https://github.com/IGJoshua/coffi/blob/1abc1fd779e86072f502251dec5e9c5350d2ef82/src/clj/coffi/mem.clj#L215">view source</a></div></div><divclass="public anchor"id="var-scope-allocator"><h3>scope-allocator</h3><divclass="usage"><code>(scope-allocator scope)</code></div><divclass="doc"><divclass="markdown"><p>Constructs a segment allocator from the given <code>scope</code>.</p>
<p>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.</p></div></div><divclass="src-link"><ahref="https://github.com/IGJoshua/coffi/blob/1abc1fd779e86072f502251dec5e9c5350d2ef82/src/clj/coffi/mem.clj#L72">view source</a></div></div><divclass="public anchor"id="var-segment-scope"><h3>segment-scope</h3><divclass="usage"><code>(segment-scope segment)</code></div><divclass="doc"><divclass="markdown"><p>Gets the scope used to construct the <code>segment</code>.</p></div></div><divclass="src-link"><ahref="https://github.com/IGJoshua/coffi/blob/1abc1fd779e86072f502251dec5e9c5350d2ef82/src/clj/coffi/mem.clj#L81">view source</a></div></div><divclass="public anchor"id="var-seq-of"><h3>seq-of</h3><divclass="usage"><code>(seq-of type segment)</code></div><divclass="doc"><divclass="markdown"><p>Constructs a lazy sequence of <code>type</code> elements deserialized from <code>segment</code>.</p></div></div><divclass="src-link"><ahref="https://github.com/IGJoshua/coffi/blob/1abc1fd779e86072f502251dec5e9c5350d2ef82/src/clj/coffi/mem.clj#L641">view source</a></div></div><divclass="public anchor"id="var-serialize"><h3>serialize</h3><divclass="usage"><code>(serialize obj type)</code><code>(serialize obj type scope)</code></div><divclass="doc"><divclass="markdown"><p>Serializes an arbitrary type.</p>
<p>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.</p></div></div><divclass="src-link"><ahref="https://github.com/IGJoshua/coffi/blob/1abc1fd779e86072f502251dec5e9c5350d2ef82/src/clj/coffi/mem.clj#L492">view source</a></div></div><divclass="public anchor"id="var-serialize*"><h3>serialize*</h3><h4class="type">multimethod</h4><divclass="usage"></div><divclass="doc"><divclass="markdown"><p>Constructs a serialized version of the <code>obj</code> and returns it.</p>
<p>This method should only be implemented for types that serialize to primitives.</p></div></div><divclass="src-link"><ahref="https://github.com/IGJoshua/coffi/blob/1abc1fd779e86072f502251dec5e9c5350d2ef82/src/clj/coffi/mem.clj#L359">view source</a></div></div><divclass="public anchor"id="var-serialize-into"><h3>serialize-into</h3><h4class="type">multimethod</h4><divclass="usage"></div><divclass="doc"><divclass="markdown"><p>Writes a serialized version of the <code>obj</code> to the given <code>segment</code>.</p>
<p>Any new allocations made during the serialization should be tied to the given <code>scope</code>, except in extenuating circumstances.</p>
<p>This method should be implemented for any type which does not override <ahref="coffi.mem.html#var-c-layout">c-layout</a>.</p>
<p>For any other type, this will serialize it as <ahref="coffi.mem.html#var-serialize*">serialize*</a> before writing the result value into the <code>segment</code>.</p>
<p>Implementations of this should be inside a <ahref="coffi.mem.html#var-with-acquired">with-acquired</a> block for the <code>scope</code> if they perform multiple memory operations.</p></div></div><divclass="src-link"><ahref="https://github.com/IGJoshua/coffi/blob/1abc1fd779e86072f502251dec5e9c5350d2ef82/src/clj/coffi/mem.clj#L424">view source</a></div></div><divclass="public anchor"id="var-shared-scope"><h3>shared-scope</h3><divclass="usage"><code>(shared-scope)</code></div><divclass="doc"><divclass="markdown"><p>Constructs a new shared scope.</p>
<p>This scope can be shared across threads and memory allocated in it will only be cleaned up once every thread accessing the scope closes it.</p></div></div><divclass="src-link"><ahref="https://github.com/IGJoshua/coffi/blob/1abc1fd779e86072f502251dec5e9c5350d2ef82/src/clj/coffi/mem.clj#L43">view source</a></div></div><divclass="public anchor"id="var-size-of"><h3>size-of</h3><divclass="usage"><code>(size-of type)</code></div><divclass="doc"><divclass="markdown"><p>The size in bytes of the given <code>type</code>.</p></div></div><divclass="src-link"><ahref="https://github.com/IGJoshua/coffi/blob/1abc1fd779e86072f502251dec5e9c5350d2ef82/src/clj/coffi/mem.clj#L347">view source</a></div></div><divclass="public anchor"id="var-slice"><h3>slice</h3><divclass="usage"><code>(slice segment offset)</code><code>(slice segment offset size)</code></div><divclass="doc"><divclass="markdown"><p>Get a slice over the <code>segment</code> with the given <code>offset</code>.</p></div></div><divclass="src-link"><ahref="https://github.com/IGJoshua/coffi/blob/1abc1fd779e86072f502251dec5e9c5350d2ef82/src/clj/coffi/mem.clj#L150">view source</a></div></div><divclass="public anchor"id="var-slice-global"><h3>slice-global</h3><divclass="usage"><code>(slice-global address size)</code></div><divclass="doc"><divclass="markdown"><p>Gets a slice of the global address space.</p>
<p>Because this fetches from the global segment, it has no associated scope, and therefore the reference created here cannot prevent the value from being freed. Be careful to ensure that you are not retaining an object incorrectly.</p></div></div><divclass="src-link"><ahref="https://github.com/IGJoshua/coffi/blob/1abc1fd779e86072f502251dec5e9c5350d2ef82/src/clj/coffi/mem.clj#L140">view source</a></div></div><divclass="public anchor"id="var-slice-into"><h3>slice-into</h3><divclass="usage"><code>(slice-into address segment)</code><code>(slice-into address segment size)</code></div><divclass="doc"><divclass="markdown"><p>Get a slice into the <code>segment</code> starting at the <code>address</code>.</p></div></div><divclass="src-link"><ahref="https://github.com/IGJoshua/coffi/blob/1abc1fd779e86072f502251dec5e9c5350d2ef82/src/clj/coffi/mem.clj#L157">view source</a></div></div><divclass="public anchor"id="var-slice-segments"><h3>slice-segments</h3><divclass="usage"><code>(slice-segments segment size)</code></div><divclass="doc"><divclass="markdown"><p>Constructs a lazy seq of <code>size</code>-length memory segments, sliced from <code>segment</code>.</p></div></div><divclass="src-link"><ahref="https://github.com/IGJoshua/coffi/blob/1abc1fd779e86072f502251dec5e9c5350d2ef82/src/clj/coffi/mem.clj#L201">view source</a></div></div><divclass="public anchor"id="var-stack-scope"><h3>stack-scope</h3><divclass="usage"><code>(stack-scope)</code></div><divclass="doc"><divclass="markdown"><p>Constructs a new scope for use only in this thread.</p>
<p>The memory allocated within this scope is cheap to allocate, like a native stack.</p></div></div><divclass="src-link"><ahref="https://github.com/IGJoshua/coffi/blob/1abc1fd779e86072f502251dec5e9c5350d2ef82/src/clj/coffi/mem.clj#L35">view source</a></div></div><divclass="public anchor"id="var-with-acquired"><h3>with-acquired</h3><h4class="type">macro</h4><divclass="usage"><code>(with-acquired scopes & body)</code></div><divclass="doc"><divclass="markdown"><p>Acquires one or more <code>scopes</code> until the <code>body</code> completes.</p>
<p>This is only necessary to do on shared scopes, however if you are operating on an arbitrary passed scope, it is best practice to wrap code that interacts with it wrapped in this.</p></div></div><divclass="src-link"><ahref="https://github.com/IGJoshua/coffi/blob/1abc1fd779e86072f502251dec5e9c5350d2ef82/src/clj/coffi/mem.clj#L100">view source</a></div></div><divclass="public anchor"id="var-with-offset"><h3>with-offset</h3><divclass="usage"><code>(with-offset address offset)</code></div><divclass="doc"><divclass="markdown"><p>Get a new address <code>offset</code> from the old <code>address</code>.</p></div></div><divclass="src-link"><ahref="https://github.com/IGJoshua/coffi/blob/1abc1fd779e86072f502251dec5e9c5350d2ef82/src/clj/coffi/mem.clj#L164">view source</a></div></div></div></body></html>
