encoding/xml: Add (*Encoder).Close() to check for unclosed elements

[Merovius]

When using (*xml.Encoder).EncodeToken, the Encoder checks for mismatched elements. That is, it returns an error if e.g. a <a> element is closed with a </b> token or if there is an extra </c> token after all elements have already been closed.

However, if the user simply forgets to close all elements, the Encoder emits incorrect XML without reporting an error. See this code, for an example. So currently, the user must track the tokens they encode themselves, to make sure the emitted XML is valid.

Flush returns an error, but as it is possible to encode more tokens after Flush has been called, it can't complain about unclosed elements itself.

I thus propose to add a new method to Encoder:

// Close the Encoder, indicating that no more data will be written. It flushes any buffered XML to the underlying writer
// and returns an error if the written XML is invalid (e.g. by containing unclosed elements).
// After Close has been called, any Encode method return errors.
func (enc *Encoder) Close() error

Naming the method Close is an indication that it should be called and the returned error should be checked by the user.

[rsc]

This proposal has been added to the active column of the proposals project
and will now be reviewed at the weekly proposal review meetings.
— rsc for the proposal review group

[rsc]

Overall this seems simple and reasonable to me.
I assume Close would also Flush, so that you can just call Close.

[Merovius]

I assume Close would also Flush, so that you can just call Close.

Yes, that's definitely the intention.

[rsc]

Based on the discussion above, this proposal seems like a likely accept.
— rsc for the proposal review group

[rsc]

No change in consensus, so accepted. 🎉
This issue now tracks the work of implementing the proposal.
— rsc for the proposal review group

[Merovius]

@rsc I'll try to send a CL, unless you tell me not to.

[gopherbot]

Change https://go.dev/cl/424777 mentions this issue: encoding/xml: add (*Encoder).Close