xmlutil

Documentation

Overview

Package xmlutil Package xml util provides XML serialization of VOLCSTACK requests and responses.

Index

• func BuildXML(params interface{}, e *xml.Encoder) error
• func StructToXML(e *xml.Encoder, node *XMLNode, sorted bool) error
• func UnmarshalXML(v interface{}, d *xml.Decoder, wrapper string) error
• func UnmarshalXMLError(v interface{}, stream io.Reader) error
• type XMLNode
  • func NewXMLElement(name xml.Name) *XMLNode
  • func XMLToStruct(d *xml.Decoder, s *xml.StartElement) (*XMLNode, error)
  • func (n *XMLNode) AddChild(child *XMLNode)

Functions

func BuildXML

func BuildXML(params interface{}, e *xml.Encoder) error

BuildXML will serialize params into an xml.Encoder. Error will be returned if the serialization of any of the params or nested values fails.

func StructToXML

func StructToXML(e *xml.Encoder, node *XMLNode, sorted bool) error

StructToXML writes an XMLNode to a xml.Encoder as tokens.

func UnmarshalXML

func UnmarshalXML(v interface{}, d *xml.Decoder, wrapper string) error

UnmarshalXML deserializes an xml.Decoder into the container v. V needs to match the shape of the XML expected to be decoded. If the shape doesn't match unmarshaling will fail.

func UnmarshalXMLError

func UnmarshalXMLError(v interface{}, stream io.Reader) error

UnmarshalXMLError unmarshals the XML error from the stream into the value type specified. The value must be a pointer. If the message fails to unmarshal, the message content will be included in the returned error as a volcengineerr.UnmarshalError.

Types

type XMLNode

type XMLNode struct {
	Name     xml.Name              `json:",omitempty"`
	Children map[string][]*XMLNode `json:",omitempty"`
	Text     string                `json:",omitempty"`
	Attr     []xml.Attr            `json:",omitempty"`
	// contains filtered or unexported fields
}

A XMLNode contains the values to be encoded or decoded.

func NewXMLElement

func NewXMLElement(name xml.Name) *XMLNode

NewXMLElement returns a pointer to a new XMLNode initialized to default values.

func XMLToStruct

func XMLToStruct(d *xml.Decoder, s *xml.StartElement) (*XMLNode, error)

XMLToStruct converts a xml.Decoder stream to XMLNode with nested values.

func (*XMLNode) AddChild

func (n *XMLNode) AddChild(child *XMLNode)

AddChild adds child to the XMLNode.