config

README

pault.ag/go/config

This package allows you define structs which both define the configuration file format, and command line flags.

package main

import (
	"fmt"
	"os"

	"pault.ag/go/config"
)

type Example struct {
	Option string `flag:"option" description:"This sets all sorts of things"`
	Value  int    `flag:"value"  description:"This is an integer value!"`
}

func main() {
	conf := Example{
		Option: "default",
	}
	flags, err := config.LoadFlags("example", &conf)
    // This will load the RFC822 formatted config from ~/.examplerc and
    // return a flag.FlagSet. The Flags will be populated by defaults from
    // the struct given.
	if err != nil {
		panic(err)
	}
	flags.Parse(os.Args[1:])
	fmt.Printf("option %s, value %d\n", conf.Option, conf.Value)
}

Documentation

Overview

{{{ Copyright (c) Paul R. Tagliamonte <paultag@gmail.com>, 2015 * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. }}}

Index

• func Flag(data interface{}) (*flag.FlagSet, error)
• func Load(name string, data interface{}) error
• func LoadFlags(name string, data interface{}) (*flag.FlagSet, error)

Functions

func Flag

func Flag(data interface{}) (*flag.FlagSet, error)

func Load

func Load(name string, data interface{}) error

func LoadFlags

func LoadFlags(name string, data interface{}) (*flag.FlagSet, error)