package xml

Import Path
	encoding/xml (on golang.org and go.dev)

Dependency Relation
	imports 12 packages, and imported by 0 packages

Involved Source Files
	    marshal.go
	    read.go
	    typeinfo.go
	d-> xml.go

Exported Type Names

type Attr (struct) An Attr represents an attribute in an XML element (Name=Value). Name Name Value string func MarshalerAttr.MarshalXMLAttr(name Name) (Attr, error) func UnmarshalerAttr.UnmarshalXMLAttr(attr Attr) error
type CharData ([]) A CharData represents XML character data (raw text), in which XML escape sequences have been replaced by the characters they represent. (T) Copy() CharData func CharData.Copy() CharData
type Comment ([]) A Comment represents an XML comment of the form <!--comment-->. The bytes do not include the <!-- and --> comment markers. (T) Copy() Comment func Comment.Copy() Comment
type Decoder (struct) A Decoder represents an XML parser reading a particular input stream. The parser assumes that its input is encoded in UTF-8. AutoClose []string CharsetReader func(charset string, input io.Reader) (io.Reader, error) DefaultSpace string Entity map[string]string Strict bool (*T) Decode(v interface{}) error (*T) DecodeElement(v interface{}, start *StartElement) error (*T) InputOffset() int64 (*T) RawToken() (Token, error) (*T) Skip() error (*T) Token() (Token, error) *T : TokenReader func NewDecoder(r io.Reader) *Decoder func NewTokenDecoder(t TokenReader) *Decoder func Unmarshaler.UnmarshalXML(d *Decoder, start StartElement) error
type Directive ([]) A Directive represents an XML directive of the form <!text>. The bytes do not include the <! and > markers. (T) Copy() Directive func Directive.Copy() Directive
type Encoder (struct) An Encoder writes XML data to an output stream. (*T) Encode(v interface{}) error (*T) EncodeElement(v interface{}, start StartElement) error (*T) EncodeToken(t Token) error (*T) Flush() error (*T) Indent(prefix, indent string) func NewEncoder(w io.Writer) *Encoder func Marshaler.MarshalXML(e *Encoder, start StartElement) error
type EndElement (struct) An EndElement represents an XML end element. Name Name func StartElement.End() EndElement
type Marshaler (interface) Marshaler is the interface implemented by objects that can marshal themselves into valid XML elements. MarshalXML encodes the receiver as zero or more XML elements. By convention, arrays or slices are typically encoded as a sequence of elements, one per entry. Using start as the element tag is not required, but doing so will enable Unmarshal to match the XML elements to the correct struct field. One common implementation strategy is to construct a separate value with a layout corresponding to the desired XML and then to encode it using e.EncodeElement. Another common strategy is to use repeated calls to e.EncodeToken to generate the XML output one token at a time. The sequence of encoded tokens must make up zero or more valid XML elements. (T) MarshalXML(e *Encoder, start StartElement) error
type MarshalerAttr (interface) MarshalerAttr is the interface implemented by objects that can marshal themselves into valid XML attributes. MarshalXMLAttr returns an XML attribute with the encoded value of the receiver. Using name as the attribute name is not required, but doing so will enable Unmarshal to match the attribute to the correct struct field. If MarshalXMLAttr returns the zero attribute Attr{}, no attribute will be generated in the output. MarshalXMLAttr is used only for struct fields with the "attr" option in the field tag. (T) MarshalXMLAttr(name Name) (Attr, error)
type Name (struct) A Name represents an XML name (Local) annotated with a name space identifier (Space). In tokens returned by Decoder.Token, the Space identifier is given as a canonical URL, not the short prefix used in the document being parsed. Local string Space string func MarshalerAttr.MarshalXMLAttr(name Name) (Attr, error)
type ProcInst (struct) A ProcInst represents an XML processing instruction of the form <?target inst?> Inst []byte Target string (T) Copy() ProcInst func ProcInst.Copy() ProcInst
type StartElement (struct) A StartElement represents an XML start element. Attr []Attr Name Name (T) Copy() StartElement (T) End() EndElement func StartElement.Copy() StartElement func (*Decoder).DecodeElement(v interface{}, start *StartElement) error func (*Encoder).EncodeElement(v interface{}, start StartElement) error func Marshaler.MarshalXML(e *Encoder, start StartElement) error func Unmarshaler.UnmarshalXML(d *Decoder, start StartElement) error
type SyntaxError (struct) A SyntaxError represents a syntax error in the XML input stream. Line int Msg string (*T) Error() string *T : error
type TagPathError (struct) A TagPathError represents an error in the unmarshaling process caused by the use of field tags with conflicting paths. Field1 string Field2 string Struct reflect.Type Tag1 string Tag2 string (*T) Error() string *T : error
type Token (interface) A Token is an interface holding one of the token types: StartElement, EndElement, CharData, Comment, ProcInst, or Directive. func CopyToken(t Token) Token func (*Decoder).RawToken() (Token, error) func (*Decoder).Token() (Token, error) func TokenReader.Token() (Token, error) func CopyToken(t Token) Token func (*Encoder).EncodeToken(t Token) error
type TokenReader (interface) A TokenReader is anything that can decode a stream of XML tokens, including a Decoder. When Token encounters an error or end-of-file condition after successfully reading a token, it returns the token. It may return the (non-nil) error from the same call or return the error (and a nil token) from a subsequent call. An instance of this general case is that a TokenReader returning a non-nil token at the end of the token stream may return either io.EOF or a nil error. The next Read should return nil, io.EOF. Implementations of Token are discouraged from returning a nil token with a nil error. Callers should treat a return of nil, nil as indicating that nothing happened; in particular it does not indicate EOF. (T) Token() (Token, error) *Decoder func NewTokenDecoder(t TokenReader) *Decoder
type Unmarshaler (interface) Unmarshaler is the interface implemented by objects that can unmarshal an XML element description of themselves. UnmarshalXML decodes a single XML element beginning with the given start element. If it returns an error, the outer call to Unmarshal stops and returns that error. UnmarshalXML must consume exactly one XML element. One common implementation strategy is to unmarshal into a separate value with a layout matching the expected XML using d.DecodeElement, and then to copy the data from that value into the receiver. Another common strategy is to use d.Token to process the XML object one token at a time. UnmarshalXML may not use d.RawToken. (T) UnmarshalXML(d *Decoder, start StartElement) error
type UnmarshalerAttr (interface) UnmarshalerAttr is the interface implemented by objects that can unmarshal an XML attribute description of themselves. UnmarshalXMLAttr decodes a single XML attribute. If it returns an error, the outer call to Unmarshal stops and returns that error. UnmarshalXMLAttr is used only for struct fields with the "attr" option in the field tag. (T) UnmarshalXMLAttr(attr Attr) error
type UnmarshalError string An UnmarshalError represents an error in the unmarshaling process. (T) Error() string T : error
type UnsupportedTypeError (struct) UnsupportedTypeError is returned when Marshal encounters a type that cannot be converted into XML. Type reflect.Type (*T) Error() string *T : error
Exported Values
func CopyToken(t Token) Token CopyToken returns a copy of a Token.
func Escape(w io.Writer, s []byte) Escape is like EscapeText but omits the error return value. It is provided for backwards compatibility with Go 1.0. Code targeting Go 1.1 or later should use EscapeText.
func EscapeText(w io.Writer, s []byte) error EscapeText writes to w the properly escaped XML equivalent of the plain text data s.
const Header = "\n" Header is a generic XML header suitable for use with the output of Marshal. This is not automatically added to any output of this package, it is provided as a convenience.
var HTMLAutoClose []string HTMLAutoClose is the set of HTML elements that should be considered to close automatically. See the Decoder.Strict and Decoder.Entity fields' documentation.
var HTMLEntity map[string]string HTMLEntity is an entity map containing translations for the standard HTML entity characters. See the Decoder.Strict and Decoder.Entity fields' documentation.
func Marshal(v interface{}) ([]byte, error) Marshal returns the XML encoding of v. Marshal handles an array or slice by marshaling each of the elements. Marshal handles a pointer by marshaling the value it points at or, if the pointer is nil, by writing nothing. Marshal handles an interface value by marshaling the value it contains or, if the interface value is nil, by writing nothing. Marshal handles all other data by writing one or more XML elements containing the data. The name for the XML elements is taken from, in order of preference: - the tag on the XMLName field, if the data is a struct - the value of the XMLName field of type Name - the tag of the struct field used to obtain the data - the name of the struct field used to obtain the data - the name of the marshaled type The XML element for a struct contains marshaled elements for each of the exported fields of the struct, with these exceptions: - the XMLName field, described above, is omitted. - a field with tag "-" is omitted. - a field with tag "name,attr" becomes an attribute with the given name in the XML element. - a field with tag ",attr" becomes an attribute with the field name in the XML element. - a field with tag ",chardata" is written as character data, not as an XML element. - a field with tag ",cdata" is written as character data wrapped in one or more <![CDATA[ ... ]]> tags, not as an XML element. - a field with tag ",innerxml" is written verbatim, not subject to the usual marshaling procedure. - a field with tag ",comment" is written as an XML comment, not subject to the usual marshaling procedure. It must not contain the "--" string within it. - a field with a tag including the "omitempty" option is omitted if the field value is empty. The empty values are false, 0, any nil pointer or interface value, and any array, slice, map, or string of length zero. - an anonymous struct field is handled as if the fields of its value were part of the outer struct. - a field implementing Marshaler is written by calling its MarshalXML method. - a field implementing encoding.TextMarshaler is written by encoding the result of its MarshalText method as text. If a field uses a tag "a>b>c", then the element c will be nested inside parent elements a and b. Fields that appear next to each other that name the same parent will be enclosed in one XML element. If the XML name for a struct field is defined by both the field tag and the struct's XMLName field, the names must match. See MarshalIndent for an example. Marshal will return an error if asked to marshal a channel, function, or map.
func MarshalIndent(v interface{}, prefix, indent string) ([]byte, error) MarshalIndent works like Marshal, but each XML element begins on a new indented line that starts with prefix and is followed by one or more copies of indent according to the nesting depth.
func NewDecoder(r io.Reader) *Decoder NewDecoder creates a new XML parser reading from r. If r does not implement io.ByteReader, NewDecoder will do its own buffering.
func NewEncoder(w io.Writer) *Encoder NewEncoder returns a new encoder that writes to w.
func NewTokenDecoder(t TokenReader) *Decoder NewTokenDecoder creates a new XML parser using an underlying token stream.
func Unmarshal(data []byte, v interface{}) error Unmarshal parses the XML-encoded data and stores the result in the value pointed to by v, which must be an arbitrary struct, slice, or string. Well-formed data that does not fit into v is discarded. Because Unmarshal uses the reflect package, it can only assign to exported (upper case) fields. Unmarshal uses a case-sensitive comparison to match XML element names to tag values and struct field names. Unmarshal maps an XML element to a struct using the following rules. In the rules, the tag of a field refers to the value associated with the key 'xml' in the struct field's tag (see the example above). * If the struct has a field of type []byte or string with tag ",innerxml", Unmarshal accumulates the raw XML nested inside the element in that field. The rest of the rules still apply. * If the struct has a field named XMLName of type Name, Unmarshal records the element name in that field. * If the XMLName field has an associated tag of the form "name" or "namespace-URL name", the XML element must have the given name (and, optionally, name space) or else Unmarshal returns an error. * If the XML element has an attribute whose name matches a struct field name with an associated tag containing ",attr" or the explicit name in a struct field tag of the form "name,attr", Unmarshal records the attribute value in that field. * If the XML element has an attribute not handled by the previous rule and the struct has a field with an associated tag containing ",any,attr", Unmarshal records the attribute value in the first such field. * If the XML element contains character data, that data is accumulated in the first struct field that has tag ",chardata". The struct field may have type []byte or string. If there is no such field, the character data is discarded. * If the XML element contains comments, they are accumulated in the first struct field that has tag ",comment". The struct field may have type []byte or string. If there is no such field, the comments are discarded. * If the XML element contains a sub-element whose name matches the prefix of a tag formatted as "a" or "a>b>c", unmarshal will descend into the XML structure looking for elements with the given names, and will map the innermost elements to that struct field. A tag starting with ">" is equivalent to one starting with the field name followed by ">". * If the XML element contains a sub-element whose name matches a struct field's XMLName tag and the struct field has no explicit name tag as per the previous rule, unmarshal maps the sub-element to that struct field. * If the XML element contains a sub-element whose name matches a field without any mode flags (",attr", ",chardata", etc), Unmarshal maps the sub-element to that struct field. * If the XML element contains a sub-element that hasn't matched any of the above rules and the struct has a field with tag ",any", unmarshal maps the sub-element to that struct field. * An anonymous struct field is handled as if the fields of its value were part of the outer struct. * A struct field with tag "-" is never unmarshaled into. If Unmarshal encounters a field type that implements the Unmarshaler interface, Unmarshal calls its UnmarshalXML method to produce the value from the XML element. Otherwise, if the value implements encoding.TextUnmarshaler, Unmarshal calls that value's UnmarshalText method. Unmarshal maps an XML element to a string or []byte by saving the concatenation of that element's character data in the string or []byte. The saved []byte is never nil. Unmarshal maps an attribute value to a string or []byte by saving the value in the string or slice. Unmarshal maps an attribute value to an Attr by saving the attribute, including its name, in the Attr. Unmarshal maps an XML element or attribute value to a slice by extending the length of the slice and mapping the element or attribute to the newly created value. Unmarshal maps an XML element or attribute value to a bool by setting it to the boolean value represented by the string. Whitespace is trimmed and ignored. Unmarshal maps an XML element or attribute value to an integer or floating-point field by setting the field to the result of interpreting the string value in decimal. There is no check for overflow. Whitespace is trimmed and ignored. Unmarshal maps an XML element to a Name by recording the element name. Unmarshal maps an XML element to a pointer by setting the pointer to a freshly allocated value and then mapping the element to that value. A missing element or empty attribute value will be unmarshaled as a zero value. If the field is a slice, a zero value will be appended to the field. Otherwise, the field will be set to its zero value.