params

type Bytes ¶

type Bytes []byte

Bytes is a string meant to hold a slice of bytes. - as a string: `{ "bucket": "name", "object": "/path/to/file" }` - as a reference to a file: "@dir/file" - from piped input: "-"

type FilePath ¶

type FilePath string

FilePath represents a file path and provides with helper to open / create either regular files or pipe stdin / stdout whenever the path is '-'.

func (f FilePath) Create() (Writer, error)

func (f FilePath) IsPipe() bool

func (f FilePath) Open() (Reader, error)

func (f FilePath) OpenPipe() (Reader, error)

func (f *FilePath) Set(val string) error

func (f *FilePath) String() string

func (f *FilePath) Type() string

type Json ¶

type Json string

Json is a string meant to hold a json value. - as a string: `{ "bucket": "name", "object": "/path/to/file" }` - as a reference to a file: "@dir/file" - from piped input: "-"

func (j Json) Interface() (interface{}, error)

func (j Json) Map() (map[string]interface{}, error)

func (j Json) Unmarshal(v interface{}) error

type PathOrReader ¶

type PathOrReader struct {
	Path string
	Read Reader
}

PathOrReader implements flag.Value such as it can be used as an attribute in another struct and used with bflags bindings.

This allows the same struct to be used for command line parameter as well as in programmatic use.

**notes**

• the path attributes _must_ be initialized otherwise bindings will error In the example below: `tr := &TestReader{Path: &PathOrReader{}}`
• the attribute MUST be a pointer not a value (*PathOrReader not PathOrReader)

Example

type TestReader struct {
	Name string        `cmd:"flag"`
	Path *PathOrReader `cmd:"flag"`
}

func (p *PathOrReader) CanRead() bool

func (p *PathOrReader) Open() (Reader, error)

func (p *PathOrReader) Set(path string) error

func (p *PathOrReader) String() string

func (p *PathOrReader) Type() string

type PathOrWriter ¶

type PathOrWriter struct {
	Path  string
	Write Writer
}

PathOrWriter implements flag.Value such as it can be used as an attribute in another struct and used with bflags bindings.

This allows the same struct to be used for command line parameter as well as in programmatic use.

**notes** - a PathOrWriter attribute _must_ be initialized for bindings to work. - the attribute MUST be a pointer not a value (*PathOrWriter not PathOrWriter)

see PathOrReader for an example.

func (p *PathOrWriter) CanWrite() bool

func (p *PathOrWriter) Create() (Writer, error)

func (p *PathOrWriter) Set(path string) error

func (p *PathOrWriter) String() string

func (p *PathOrWriter) Type() string

type Reader ¶

type Reader interface {
	io.Reader
	io.Closer
}

func NopCloser(f io.Reader) Reader

type Writer ¶

type Writer interface {
	io.Writer
	io.Closer
}

func NopWriteCloser(w io.Writer) Writer