yaml

package

v1.1.21 Latest Latest Go to latest Published: Sep 25, 2019 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/phR0ze/n

Links

Open Source Insights

Documentation ¶

Overview ¶

Package yaml provides helper functions for working with yaml

Index ¶

func Marshal(o interface{}) ([]byte, error)
func ReadYAML(filepath string) (obj map[string]interface{}, err error)
func Unmarshal(y []byte, o interface{}) error
func WriteYAML(filepath string, obj interface{}, perms ...uint32) (err error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Marshal ¶

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

Marshal wraps the ghodss/yaml.Marshal

func ReadYAML ¶

func ReadYAML(filepath string) (obj map[string]interface{}, err error)

ReadYAML reads the target file and returns a map[string]interface{} data structure representing the yaml read in.

func Unmarshal ¶

func Unmarshal(y []byte, o interface{}) error

Unmarshal wraps the ghodss/yaml.Unmarshal

func WriteYAML ¶

func WriteYAML(filepath string, obj interface{}, perms ...uint32) (err error)

WriteYAML converts the given obj interface{} into yaml then writes to disk with default permissions. Expects obj to be a structure that github.com/ghodss/yaml understands

Types ¶

This section is empty.

Source Files ¶

View all Source files

yaml.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL