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.

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

encoding/xml: Inconsistent XMLName behaviour for Marshal/Unmarshal #2265

Closed
gopherbot opened this issue Sep 16, 2011 · 2 comments
Closed

encoding/xml: Inconsistent XMLName behaviour for Marshal/Unmarshal #2265

gopherbot opened this issue Sep 16, 2011 · 2 comments

Comments

@gopherbot
Copy link

by chrisfarms:

When xml.Marshal is called on a struct it will happily reflect the information in the
"tag" of an XMLName member regardless of the type to give the struct a
tag-name in it's XML form. This is backed up by the documentation which says:
 
> The name of that XML element is taken from, in order of preference:
>     - the tag on an XMLName field, if the data is a struct               
>     - the value of an XMLName field of type xml.Name
>     ...

However xml.Unmarshal *does* care about the XMLName field being of type xml.Name, and
currently returns the error "field XMLName does not have type xml.Name" if you
have it set to something else.

This is firstly inconsistant with xml.Marshal but it also makes it impossible to use
xml.Marshal alongside other Marshallers (like json/bson) without poluting the state's
namespace with XMLName fields. Inorder to exclude fields from other Marshallers the
convention has been started to tag fields as "omitempty"; which will cause the
field not to display if it is at it's "zero" state, XMLName cannot have such
as zero-state since it is a struct, so it is nicer to use a pointer/bool value for
XMLName so it can be easily excluded when I want to Marshal my struct by some other wire
format.

Attached is the proposed minor change, that simply stops erring if it can't set the name
on the XMLName field, which is just optional metadata anyway.

Attachments:

  1. go-xml-read.diff (525 bytes)
@rsc
Copy link
Contributor

rsc commented Sep 19, 2011

Comment 1:

Sounds reasonable to me.  Want to submit a CL?
http://golang.org/doc/contribute.html
Thanks.
Russ

Owner changed to @rsc.

Status changed to Accepted.

@rsc
Copy link
Contributor

rsc commented Oct 14, 2011

Comment 2:

This issue was closed by revision 55751a3.

Status changed to Fixed.

@mikioh mikioh changed the title Inconsistant XMLName behaviour for xml.Marshal/Unmarshal encoding/xml: Inconsistent XMLName behaviour for Marshal/Unmarshal Jan 9, 2015
@golang golang locked and limited conversation to collaborators Jun 24, 2016
@rsc rsc removed their assignment Jun 22, 2022
This issue was closed.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants