metavars

package

v0.4.0 Latest Latest Go to latest Published: Oct 30, 2021 License: BSD-3-Clause Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package metavars allows manipulation of "meta variables" stored as variable declarations in Go files.

This section is empty.

This section is empty.

func Write(w io.Writer, f *File) error

Write file f to write w.

func WriteFile(filename string, f *File) error

WriteFile writes f to the given file.

type File struct {
	Package    string
	Properties []Property
}

File of property definitions.

func Read(r io.Reader) (*File, error)

Read properties from the given reader.

func ReadFile(filename string) (*File, error)

ReadFile reads properties file.

func (f *File) Add(p Property) error

Add property to the file, which must not already exist.

func (f *File) Get(name string) (string, bool)

Get property with given name.

func (f *File) Set(name, value string) error

Set property name to value. The property must exist.

type Property struct {
	Name  string
	Doc   string
	Value string
}

Property is a string variable.