utils

Documentation

Index

• func DownloadFile(filepath string, url string) error
• func GetHome() string
• func ReadFileSource(uri string) (string, error)
• func ReadLocalFile(location string) (string, error)
• func ReadRemoteFile(url string) (string, error)
• type JSONMarshaller
  • func (j *JSONMarshaller) Marshal(obj interface{}) (string, error)
  • func (j *JSONMarshaller) Unmarshal(obj string, result interface{}) error
• type Marshaller
• type Unmarshaller

Functions

func DownloadFile

func DownloadFile(filepath string, url string) error

func GetHome

func GetHome() string

GetHome returns the home path

func ReadFileSource

func ReadFileSource(uri string) (string, error)

ReadFileSource supports "http", "https", and "file" protocols. It takes in the location as a URI and returns the contents of the file as a string.

func ReadLocalFile

func ReadLocalFile(location string) (string, error)

ReadLocalFile takes in the location of a local file in the format `file://location/of/file` and returns the content of the file if the path is valid and no error occurs.

func ReadRemoteFile

func ReadRemoteFile(url string) (string, error)

ReadRemoteFile takes in the location of a remote file in the format 'http://location/of/file' or 'https://location/file' and returns the content of the file if the location is valid and no error occurs.

Types

type JSONMarshaller

type JSONMarshaller struct{}

func (*JSONMarshaller) Marshal

func (j *JSONMarshaller) Marshal(obj interface{}) (string, error)

func (*JSONMarshaller) Unmarshal

func (j *JSONMarshaller) Unmarshal(obj string, result interface{}) error

type Marshaller

type Marshaller interface {
	Marshal(interface{}) (string, error)
}

type Unmarshaller

type Unmarshaller interface {
	Unmarshal(string, interface{}) error
}