xml

Documentation

Overview

Package xml holds the encoder/decoder implementation for `application/xml`.

Index

• Variables
• func Decode(ctx context.Context, in, out interface{}) error
• func Encode(ctx context.Context, in interface{}) ([]byte, error)

Variables

var (
	// LatencyMs measures the latency in milliseconds for the CloudEvents xml data
	// codec methods.
	LatencyMs = stats.Float64("cloudevents.io/sdk-go/datacodec/xml/latency", "The latency in milliseconds for the CloudEvents xml data codec methods.", "ms")
)

var (
	// LatencyView is an OpenCensus view that shows data codec xml method latency.
	LatencyView = &view.View{
		Name:        "datacodec/xml/latency",
		Measure:     LatencyMs,
		Description: "The distribution of latency inside of the xml data codec for CloudEvents.",
		Aggregation: view.Distribution(0, .01, .1, 1, 10, 100, 1000, 10000),
		TagKeys:     observability.LatencyTags(),
	}
)

Functions

func Decode

func Decode(ctx context.Context, in, out interface{}) error

Decode takes `in` as []byte, or base64 string, normalizes in to unquoted and base64 decoded []byte if required, and then attempts to use xml.Unmarshal to convert those bytes to `out`. Returns and error if this process fails.

func Encode

func Encode(ctx context.Context, in interface{}) ([]byte, error)

Encode attempts to xml.Marshal `in` into bytes. Encode will inspect `in` and returns `in` unmodified if it is detected that `in` is already a []byte; Or xml.Marshal errors.