fileutil

Documentation

Overview

Package fileutil provides utilities for file operations

Index

• Constants
• func FileExists(file string) error
• func FileNames(folder string) ([]string, error)
• func FolderExists(dir string) error
• func LoadConfigWithSchema(config string) (string, error)
• func Marshal(fn string, value interface{}) error
• func SaveConfigWithSchema(path, value string) error
• func SubfolderNames(folder string) ([]string, error)
• func Unmarshal(file string, v interface{}) error

Constants

const (
	// FileSource specifies to load config from a file
	FileSource = "file://"
	// EnvSource specifies to load config from an environment variable
	EnvSource = "env://"
)

Functions

func FileExists

func FileExists(file string) error

FileExists ensures that file exists

func FileNames

func FileNames(folder string) ([]string, error)

FileNames returns list of files in provided folder.

func FolderExists

func FolderExists(dir string) error

FolderExists ensures that folder exists

func LoadConfigWithSchema

func LoadConfigWithSchema(config string) (string, error)

LoadConfigWithSchema returns a configuration loaded from file:// or env:// If config does not start with file:// or env://, then the value is returned as is

func Marshal

func Marshal(fn string, value interface{}) error

Marshal saves object to file

func SaveConfigWithSchema

func SaveConfigWithSchema(path, value string) error

SaveConfigWithSchema saves configuration to file:// or env://

func SubfolderNames

func SubfolderNames(folder string) ([]string, error)

SubfolderNames returns list of subfolders in provided folder

func Unmarshal

func Unmarshal(file string, v interface{}) error

Unmarshal JSON or YAML file to an interface