yml

Documentation

Index

• func ContextWithConfig(ctx context.Context, config *Config) context.Context
• func CreateOrUpdateKeyNode(ctx context.Context, key string, keyNode *yaml.Node) *yaml.Node
• func CreateOrUpdateMapNodeElement(ctx context.Context, key string, keyNode, valueNode, mapNode *yaml.Node) *yaml.Node
• func CreateOrUpdateScalarNode(ctx context.Context, value any, valueNode *yaml.Node) *yaml.Node
• func CreateOrUpdateSliceNode(ctx context.Context, elements []*yaml.Node, valueNode *yaml.Node) *yaml.Node
• func DeleteMapNodeElement(ctx context.Context, key string, mapNode *yaml.Node) *yaml.Node
• func GetMapElementNodes(ctx context.Context, mapNode *yaml.Node, key string) (*yaml.Node, *yaml.Node, bool)
• type Config
  • func GetConfigFromContext(ctx context.Context) *Config
  • func GetConfigFromDoc(data []byte, doc *yaml.Node) *Config
• type OutputFormat

Functions

func ContextWithConfig

func ContextWithConfig(ctx context.Context, config *Config) context.Context

func CreateOrUpdateKeyNode

func CreateOrUpdateKeyNode(ctx context.Context, key string, keyNode *yaml.Node) *yaml.Node

func CreateOrUpdateMapNodeElement

func CreateOrUpdateMapNodeElement(ctx context.Context, key string, keyNode, valueNode, mapNode *yaml.Node) *yaml.Node

func CreateOrUpdateScalarNode

func CreateOrUpdateScalarNode(ctx context.Context, value any, valueNode *yaml.Node) *yaml.Node

func CreateOrUpdateSliceNode

func CreateOrUpdateSliceNode(ctx context.Context, elements []*yaml.Node, valueNode *yaml.Node) *yaml.Node

func DeleteMapNodeElement

func DeleteMapNodeElement(ctx context.Context, key string, mapNode *yaml.Node) *yaml.Node

func GetMapElementNodes

func GetMapElementNodes(ctx context.Context, mapNode *yaml.Node, key string) (*yaml.Node, *yaml.Node, bool)

Types

type Config

type Config struct {
	KeyStringStyle   yaml.Style   // The default string style to use when creating new keys
	ValueStringStyle yaml.Style   // The default string style to use when creating new nodes
	Indentation      int          // The indentation level of the document
	OutputFormat     OutputFormat // The output format to use when marshalling
}

func GetConfigFromContext

func GetConfigFromContext(ctx context.Context) *Config

func GetConfigFromDoc

func GetConfigFromDoc(data []byte, doc *yaml.Node) *Config

type OutputFormat

type OutputFormat string

const (
	OutputFormatJSON OutputFormat = "json"
	OutputFormatYAML OutputFormat = "yaml"
)