luciano/coffi
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

improve defstruct doc

Browse source
This commit is contained in:
Kristin Rutenkolk 2024-12-19 12:28:43 +01:00
parent 87e9bb7a7b
commit bba05c7dfd
1 changed files with 6 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
src/clj/coffi/mem.clj
View file

@ -1634,7 +1634,7 @@
(range n)) (range n))
[(if raw? gen-arr (list `vec gen-arr))])])) [(if raw? gen-arr (list `vec gen-arr))])]))
(defn typelist [typename fields] (defn- typelist [typename fields]
(->> (->>
(partition 2 2 (interleave (reductions + 0 (map (comp size-of second) fields)) fields)) (partition 2 2 (interleave (reductions + 0 (map (comp size-of second) fields)) fields))
(filter (fn [[_ [_ field-type]]] (not (and (vector? field-type) (= ::padding (first field-type)))))))) (filter (fn [[_ [_ field-type]]] (not (and (vector? field-type) (= ::padding (first field-type))))))))
@ -1927,7 +1927,11 @@
(defmacro defstruct (defmacro defstruct
"Defines a struct type. all members need to be supplied in pairs of `coffi-type member-name`. "Defines a struct type. all members need to be supplied in pairs of `coffi-type member-name`.
This creates needed serialization and deserialization implementations for the new type." This creates needed serialization and deserialization implementations for the new type.
The typenames have to be coffi typenames, such as `:coffi.mem/int` or `[:coffi.mem/array :coffi.mem/byte 3]`.
Arrays are wrapped with vectors by default. If you want to use raw java arrays the array type has to be supplied with the option `:raw? true`, for example like this `[:coffi.mem/array :coffi.mem/byte 3 :raw? true]`
"
{:style/indent [:defn]} {:style/indent [:defn]}
[typename members] [typename members]
(let [invalid-typenames (filter #(try (c-layout (first %)) nil (catch Exception e (first %))) (partition 2 members))] (let [invalid-typenames (filter #(try (c-layout (first %)) nil (catch Exception e (first %))) (partition 2 members))]