add new function struct2dict (#139)

* add new function struct2dict

* fix version to 1.10

* change struct2ntuple to use fieldnames

Author: ssikdar1

CHANGELOG.md

@@ -1,3 +1,6 @@
+# 1.10.0
+* New function `struct2ntuple` that converts a struct to a NamedTuple (for saving)
+
 # 1.9.0
 * `savename` now has the `ignore` option.
 

Project.toml

@@ -1,7 +1,7 @@
 name = "DrWatson"
 uuid = "634d3b9d-ee7a-5ddf-bec9-22491ea816e1"
 repo = "https://github.com/JuliaDynamics/DrWatson.jl.git"
-version = "1.9.2"
+version = "1.10.0"
 
 [deps]
 FileIO = "5789e2e9-d7fb-5bc7-8068-2c6fae9b9549"

docs/src/save.md

@@ -63,4 +63,5 @@ See [Stopping "Did I run this?"](@ref) for an example usage of `produce_or_load`
 [`savename`](@ref) gives great support for getting a name out of any Julia composite type. To save something though, one needs a dictionary. So the following function can be conveniently used to directly save a struct using any saving function:
 ```@docs
 struct2dict
+struct2ntuple
 ```

src/saving_tools.jl

@@ -301,4 +301,14 @@ tagsave(savename(s), struct2dict(s))
 """
 function struct2dict(s)
     Dict(x => getfield(s, x) for x in fieldnames(typeof(s)))
-end
+end
+
+export struct2ntuple
+
+"""
+    struct2ntuple(s) -> n
+Convert a Julia composite type `s` to a NamedTuple `n`.
+"""
+function struct2ntuple(s)
+    NamedTuple{fieldnames(typeof(s))}(( getfield(s, x) for x in fieldnames(typeof(s))))
+end

test/customize_savename.jl

@@ -46,6 +46,12 @@ for x in fieldnames(typeof(e1))
     @test d[x] == getfield(e1, x)
 end
 
+nt = struct2ntuple(e1)
+@test isa(nt, NamedTuple)
+for x in fieldnames(typeof(e1))
+    @test nt[x] == getfield(e1, x)
+end
+
 # Test extra dir and default_prefix:
 s = savename(joinpath("path", "to", "data"), e1)
 @test s[1:4] == "path"