yamlx

Documentation

Index

• func Open(v any, filename string) error
• func OpenFS(v any, fsys fs.FS, filename string) error
• func OpenFiles(v any, filenames ...string) error
• func OpenFilesFS(v any, fsys fs.FS, filenames ...string) error
• func Read(v any, reader io.Reader) error
• func ReadBytes(v any, data []byte) error
• func Save(v any, filename string) error
• func Write(v any, writer io.Writer) error
• func WriteBytes(v any) ([]byte, error)

Functions

func Open

func Open(v any, filename string) error

Open reads the given object from the given filename using YAML encoding

func OpenFS

func OpenFS(v any, fsys fs.FS, filename string) error

OpenFS reads the given object from the given filename using YAML encoding, using the given fs.FS filesystem (e.g., for embed files)

func OpenFiles

func OpenFiles(v any, filenames ...string) error

OpenFiles reads the given object from the given filenames using YAML encoding

func OpenFilesFS

func OpenFilesFS(v any, fsys fs.FS, filenames ...string) error

OpenFilesFS reads the given object from the given filenames using YAML encoding, using the given fs.FS filesystem (e.g., for embed files)

func Read

func Read(v any, reader io.Reader) error

Read reads the given object from the given reader, using YAML encoding

func ReadBytes

func ReadBytes(v any, data []byte) error

ReadBytes reads the given object from the given bytes, using YAML encoding

func Save

func Save(v any, filename string) error

Save writes the given object to the given filename using YAML encoding

func Write

func Write(v any, writer io.Writer) error

Write writes the given object using YAML encoding

func WriteBytes

func WriteBytes(v any) ([]byte, error)

WriteBytes writes the given object, returning bytes of the encoding, using YAML encoding