file

Documentation

Overview

Package file provides functions that combine file handling, JSON marshaling and file system abstraction.

Index

• Variables
• type Handler
  • func NewHandler(fs afero.Fs) Handler
  • func (h *Handler) MkdirAll(name string) error
  • func (h *Handler) Read(name string) ([]byte, error)
  • func (h *Handler) ReadJSON(name string, content any) error
  • func (h *Handler) ReadYAML(name string, content any) error
  • func (h *Handler) ReadYAMLStrict(name string, content any) error
  • func (h *Handler) Remove(name string) error
  • func (h *Handler) RemoveAll(name string) error
  • func (h *Handler) Stat(name string) (fs.FileInfo, error)
  • func (h *Handler) Write(name string, data []byte, options ...Option) error
  • func (h *Handler) WriteJSON(name string, content any, options ...Option) error
  • func (h *Handler) WriteYAML(name string, content any, options ...Option) (err error)
• type Option

Variables

var (
	// OptNone is a no-op.
	OptNone = Option{optNone}
	// OptOverwrite overwrites an existing file.
	OptOverwrite = Option{optOverwrite}
	// OptMkdirAll creates the path to the file.
	OptMkdirAll = Option{optMkdirAll}
)

Types

type Handler

type Handler struct {
	// contains filtered or unexported fields
}

Handler handles file interaction.

func NewHandler

func NewHandler(fs afero.Fs) Handler

NewHandler returns a new file handler.

func (*Handler) MkdirAll

func (h *Handler) MkdirAll(name string) error

MkdirAll creates a directory path and all parents that does not exist yet.

func (*Handler) Read

func (h *Handler) Read(name string) ([]byte, error)

Read reads the file given name and returns the bytes read.

func (*Handler) ReadJSON

func (h *Handler) ReadJSON(name string, content any) error

ReadJSON reads a JSON file from name and unmarshals it into the content interface. The interface content must be a pointer to a JSON marchalable object.

func (*Handler) ReadYAML

func (h *Handler) ReadYAML(name string, content any) error

ReadYAML reads a YAML file from name and unmarshals it into the content interface. The interface content must be a pointer to a YAML marchalable object.

func (*Handler) ReadYAMLStrict

func (h *Handler) ReadYAMLStrict(name string, content any) error

ReadYAMLStrict does the same as ReadYAML, but fails if YAML contains fields that are not specified in content.

func (*Handler) Remove

func (h *Handler) Remove(name string) error

Remove deletes the file with the given name.

func (*Handler) RemoveAll

func (h *Handler) RemoveAll(name string) error

RemoveAll deletes the file or directory with the given name.

func (*Handler) Stat

func (h *Handler) Stat(name string) (fs.FileInfo, error)

Stat returns a FileInfo describing the named file, or an error, if any happens.

func (*Handler) Write

func (h *Handler) Write(name string, data []byte, options ...Option) error

Write writes the data bytes into the file with the given name.

func (*Handler) WriteJSON

func (h *Handler) WriteJSON(name string, content any, options ...Option) error

WriteJSON marshals the content interface to JSON and writes it to the path with the given name.

func (*Handler) WriteYAML

func (h *Handler) WriteYAML(name string, content any, options ...Option) (err error)

WriteYAML marshals the content interface to YAML and writes it to the path with the given name.

type Option

type Option struct {
	// contains filtered or unexported fields
}

Option is a bitmask of options for file operations.