encoding

package

v0.1.0 Latest Latest Go to latest Published: Apr 2, 2021 License: Apache-2.0 Imports: 9 Imported by: 10

Details

encoding is a package of default encodings supplied with mimic.

Each of the encodings match the following func declaration: ``` func XXX(in interface{}) io.Reader { ```

Encodings are called when generating the desired output for a configuration.

Additional encoders should return `io.Reader` and can be imported directly into the configuration.

This section is empty.

This section is empty.

func GhodssYAML(in ...interface{}) io.Reader

GhodssYAML returns reader that encodes anything to YAML using github.com/ghodss/yaml. Desired for e.g: * Kubernetes

func HCL(in interface{}) io.Reader

func JSON(in interface{}) io.Reader

JSON returns reader that encodes anything to JSON.

func JSONPB(in proto.Message) io.Reader

JSONPB returns reader that encodes protobuf messages to JSON. NOTE: The jsonpb marshaler behaves slightly differently to go's built in marshaler.

func YAML(in ...interface{}) io.Reader

YAML returns reader that encodes anything to YAML using gopkg.in/yaml.v2. Desired for e.g: * Prometheus, Alertmanager configuration

type MarshalFunc func(o interface{}) ([]byte, error)