Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#184: Allow custom unmarshal implementation #185

Merged
merged 2 commits into from
Feb 8, 2022
Merged

#184: Allow custom unmarshal implementation #185

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
caee723
Allow custom unmarshal implementation
Jan 25, 2022
ca8c539
Merge branch 'master' into unmarshal
errorhandler Feb 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions ion/unmarshal.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,11 @@ var typesAcceptableKinds = map[Type][]reflect.Kind{
ListType: {reflect.Slice, reflect.Array},
}

// Unmarshaler is the interface implemented by types that can unmarshal themselves to Ion.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// Unmarshaler is the interface implemented by types that can unmarshal themselves to Ion.
// Unmarshaler is the interface implemented by types that can unmarshal themselves from Ion.

type Unmarshaler interface {
UnmarshalIon(r Reader) error
}

// Unmarshal unmarshals Ion data to the given object.
//
// User must pass the proper object type to the unmarshalled Ion data.
Expand Down Expand Up @@ -289,6 +294,8 @@ func (d *Decoder) DecodeTo(v interface{}) error {
return d.decodeTo(rv)
}

var unmarshalerType = reflect.TypeOf((*Unmarshaler)(nil)).Elem()

func (d *Decoder) decodeTo(v reflect.Value) error {
if !v.IsValid() {
// Don't actually have anywhere to put this value; skip it.
Expand All @@ -305,6 +312,11 @@ func (d *Decoder) decodeTo(v reflect.Value) error {
return nil
}

t := v.Type()
if t.Kind() != reflect.Ptr && v.CanAddr() && reflect.PtrTo(t).Implements(unmarshalerType) {
return v.Addr().Interface().(Unmarshaler).UnmarshalIon(d.r)
}

switch d.r.Type() {
case BoolType:
return d.decodeBoolTo(v)
Expand Down
23 changes: 23 additions & 0 deletions ion/unmarshal_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,6 +316,29 @@ func TestUnmarshalStructBinary(t *testing.T) {
test(ionByteValue, "structToStruct", &foo{}, &foo{2}) // unmarshal IonStruct to a Go struct
}

type unmarshalMe struct {
Name string
custom bool
}

func (u *unmarshalMe) UnmarshalIon(r Reader) error {
u.custom = true
return nil
}

func TestUnmarshalCustomMarshaler(t *testing.T) {
ionBinary, err := MarshalBinary(unmarshalMe{
Name: "John Doe",
})
require.NoError(t, err)

dec := NewDecoder(NewReader(bytes.NewReader(ionBinary)))
var decodedResult unmarshalMe

assert.NoError(t, dec.DecodeTo(&decodedResult))
assert.True(t, decodedResult.custom)
}

func TestUnmarshalListSexpBinary(t *testing.T) {
test := func(data []byte, testName string, val, eval interface{}) {
t.Run("reflect.TypeOf(val).String()", func(t *testing.T) {
Expand Down