yml

Documentation

Overview

Package yml reads a Declaration File in YML format.

Index

• type DeclarationYML
  • func NewDeclarationYML(filename string) *DeclarationYML
  • func (declarationYML *DeclarationYML) Read() (*envvars.Declaration, error)
  • func (declarationYML *DeclarationYML) Write(d *envvars.Declaration, overwrite bool) error

Types

type DeclarationYML

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

DeclarationYML handles read/write of a Declaration YML file

func NewDeclarationYML

func NewDeclarationYML(filename string) *DeclarationYML

NewDeclarationYML returns a DeclarationYML object

func (*DeclarationYML) Read

func (declarationYML *DeclarationYML) Read() (*envvars.Declaration, error)

Read returns a Declaration from a yml file

func (*DeclarationYML) Write

func (declarationYML *DeclarationYML) Write(d *envvars.Declaration, overwrite bool) error

Write writes a Declaration object to a yml file. Returns error if the file already exists unless overwrite is true