hog

Documentation

Index

• Variables
• func AddFiles(files []string) (string, error)
• func BaseDir() (string, error)
• func CreateEmptyHogFile(hogPath string) error
• func GetID() string
• func Path() (string, error)
• func Save(hog Hog) error
• func SaveToPath(hogPath string, hog Hog) error
• func Url(hog Hog, id string) string
• type Hog
  • func FromPath(hogPath string) (Hog, error)
  • func Get() (Hog, error)

Variables

var FILE = ".hog.yml"

FILE name of the hog configuration file

Functions

func AddFiles

func AddFiles(files []string) (string, error)

AddFiles to the hog file and return the bucket id

func BaseDir

func BaseDir() (string, error)

BaseDir return the path of the directory that contains the hog file

func CreateEmptyHogFile

func CreateEmptyHogFile(hogPath string) error

CreateEmptyHogFile create a default hog object in the default hog path

func GetID

func GetID() string

GetID returns a random id

func Path

func Path() (string, error)

Path return the path of the hog file

func Save

func Save(hog Hog) error

Save a hog object in the default hog path

func SaveToPath

func SaveToPath(hogPath string, hog Hog) error

SaveToPath saves a hog object in a specific path

func Url

func Url(hog Hog, id string) string

Url from a hog object

Types

type Hog

type Hog struct {
	Domain   string              `yaml:"domain"`
	Protocol string              `yaml:"protocol"`
	Port     int                 `yaml:"port"`
	Buckets  map[string][]string `yaml:"buckets"`
}

Hog hold the structure of the files

func FromPath

func FromPath(hogPath string) (Hog, error)

FromPath load a hog object from an specific path

func Get

func Get() (Hog, error)

Get the hog object from the hog path