boxfile

Documentation

Index

• type Boxfile
  • func New(raw []byte) Boxfile
  • func NewFromPath(path string) Boxfile
  • func (self *Boxfile) AddStorageNode()
  • func (b Boxfile) BoolValue(name string) bool
  • func (self Boxfile) Equal(other Boxfile) bool
  • func (b *Boxfile) FillRaw()
  • func (b Boxfile) IntValue(name string) int
  • func (self *Boxfile) Merge(box Boxfile)
  • func (self *Boxfile) MergeProc(box Boxfile)
  • func (self Boxfile) Node(name string) (box Boxfile)
  • func (b Boxfile) Nodes(types ...string) (rtn []string)
  • func (self Boxfile) SaveToPath(path string) error
  • func (self Boxfile) String() string
  • func (b Boxfile) StringSliceValue(name string) []string
  • func (b Boxfile) StringValue(name string) string
  • func (b Boxfile) Value(name string) interface{}
  • func (b Boxfile) VersionValue(name string) string

Types

type Boxfile

type Boxfile struct {
	Parsed map[string]interface{}
	Valid  bool
	// contains filtered or unexported fields
}

func New

func New(raw []byte) Boxfile

New returns a boxfile object from raw data

func NewFromPath

func NewFromPath(path string) Boxfile

NewFromPath creates a new boxfile from a file instead of raw bytes

func (*Boxfile) AddStorageNode

func (self *Boxfile) AddStorageNode()

Adds any missing storage nodes that are implied in the web => network_dirs but not explicitly placed inside the root as a nfs node

func (Boxfile) BoolValue

func (b Boxfile) BoolValue(name string) bool

func (Boxfile) Equal

func (self Boxfile) Equal(other Boxfile) bool

func (*Boxfile) FillRaw

func (b *Boxfile) FillRaw()

FillRaw is used when a boxfile is create from an existing boxfile and we want to see what the raw would look like

func (Boxfile) IntValue

func (b Boxfile) IntValue(name string) int

func (*Boxfile) Merge

func (self *Boxfile) Merge(box Boxfile)

Merge puts a new boxfile data ontop of your existing boxfile

func (*Boxfile) MergeProc

func (self *Boxfile) MergeProc(box Boxfile)

MergeProc drops a procfile into the existing boxfile

func (Boxfile) Node

func (self Boxfile) Node(name string) (box Boxfile)

Node returns just a specific node from the boxfile if the object is a sub hash it returns a boxfile object this allows Node to be chained if you know the data

func (Boxfile) Nodes

func (b Boxfile) Nodes(types ...string) (rtn []string)

list nodes allow the user to specify which types of nodes your interested in

func (Boxfile) SaveToPath

func (self Boxfile) SaveToPath(path string) error

func (Boxfile) String

func (self Boxfile) String() string

func (Boxfile) StringSliceValue

func (b Boxfile) StringSliceValue(name string) []string

func (Boxfile) StringValue

func (b Boxfile) StringValue(name string) string

func (Boxfile) Value

func (b Boxfile) Value(name string) interface{}

func (Boxfile) VersionValue

func (b Boxfile) VersionValue(name string) string