Skip to content

Latest commit

 

History

History
59 lines (43 loc) · 1.9 KB

README.md

File metadata and controls

59 lines (43 loc) · 1.9 KB

clj-struct

A simple Clojure library that packs/unpacks sequences of values to/from byte buffers. The library was inspired by Python [struct] 1 module.

Usage

Include the library in your leiningen project dependencies:

[clj-struct "0.1.0-SNAPSHOT"]

Supported Format Characters

Format C Type Clojure type Size
c char char 1
b signed char byte 1
B unsigned char int 1
? _Bool boolean 1
h short short 2
H unsigned short int 2
i int int 4
I unsigned int long 4
l long int 4
L unsigned long long 4
q long long long 8
Q unsigned long long BigInt 8
f float float 4
d double double 8
s char[] string

Examples

(use 'clj-struct.core)

; calculates the size of the struct corresponding to the given format
(calc-size "11sii?")

; returns a byte buffer containing the values packed according to the given format
(def bytes-buf (pack "11sii?" ["some string" -28 499 false]))

; returns a sequence of unpacked values
(def unpacked-seq (unpack "11sii?" bytes-buf))

; reads first 30 integers from a binary file
(with-open [file (RandomAccessFile. "/path/to/file" "r")]
  (unpack "30i" file))

License

Copyright © 2013 Pavel Prokopenko

Distributed under the Eclipse Public License, the same as Clojure.