Serialize native Nim types to strings, streams, sockets, or anything else.
- references
- distincts
- cycles
- inheritance
- variants
gc:arcgc:orcgc:refcc++- for broader support, use a prior frosty
There are two operations: freeze and thaw.
Each takes as input a target and the data to serialize or deserialize.
This example uses the frosty/streams target supplied in this repository.
import frosty/streams
type
MyObject = object
x: int
y: string
var
data = MyObject(x: 4, y: "three")
handle = openFileStream("somefile", fmWrite)
# write serialized data into the file stream
freeze(handle, data)
close handleThis example uses the frosty/streams target supplied in this repository.
import frosty/streams
var
data: MyObject
handle = openFileStream("somefile", fmRead)
# read deserialized data from the file stream
thaw(handle, data)
assert data == MyObject(x: 4, y: "three")
close handleIf you want to alter the serialization for a type, simply implement serialize
and deserialize procedures for your type.
proc serialize*[S](output: var S; login: LoginCredentials) =
## avoid accidentally serializing passwords
serialize(output, login.username)
proc deserialize*[S](input: var S; login: var LoginCredentials) =
login.password = "{scrubbed}"
deserialize(input, login.username)You merely provide two forms of reading and writing for your target -- simple types such as ordinals or floats, and strings, for which you are additionally provided a length argument for your convenience.
This is an implementation of a Stream target.
import frosty
export frosty
proc serialize*(output: var Stream; input: string; length: int) =
write(output, input)
proc deserialize*(input: var Stream; output: var string; length: int) =
readStr(input, length, output)
proc serialize*[T](output: var Stream; input: T) =
write(output, input)
proc deserialize*[T](input: var Stream; output: var T) =
read(input, output)The frosty/streams module also provides an even simpler freeze and thaw
API that uses StringStream to provide basic string-based input and output.
import frosty/streams
var brrr = freeze MyObject(x: 2, y: "four")
assert thaw[MyObject](brrr) == MyObject(x: 2, y: "four")$ nimph clone disruptek/frosty
or if you're still using Nimble like it's 2012,
$ nimble install https://github.com/disruptek/frosty
MIT