ext

Documentation

Index

• func InstallBashCompletion(root *cli.Command) error
• type CSVRecord
  • func (d CSVRecord) Bools() ([]bool, error)
  • func (d *CSVRecord) Decode(s string) error
  • func (d CSVRecord) Floats() ([]float64, error)
  • func (d CSVRecord) Ints() ([]int64, error)
  • func (d CSVRecord) Strings() []string
  • func (d CSVRecord) Uints() ([]uint64, error)
• type Duration
  • func (d *Duration) Decode(s string) error
  • func (d Duration) Encode() string
• type File
  • func (f File) Data() []byte
  • func (f *File) Decode(s string) error
  • func (f File) Encode() string
  • func (f File) String() string
• type PidFile
  • func (pid *PidFile) Decode(s string) error
  • func (pid PidFile) New() error
  • func (pid PidFile) Remove() error
  • func (pid PidFile) String() string
• type Reader
  • func (r Reader) Close() error
  • func (r *Reader) Decode(s string) error
  • func (r Reader) IsStdin() bool
  • func (r Reader) Name() string
  • func (r Reader) Read(data []byte) (n int, err error)
  • func (r *Reader) SetReader(reader io.Reader)
• type Time
  • func (t *Time) Decode(s string) error
  • func (t Time) Encode() string
  • func (t Time) IsSet() bool
• type Writer
  • func (w *Writer) Close() error
  • func (w *Writer) Decode(s string) error
  • func (w Writer) IsStdout() bool
  • func (w *Writer) Name() string
  • func (w *Writer) SetWriter(writer io.Writer)
  • func (w *Writer) Write(data []byte) (n int, err error)

Examples

• Duration
• File
• Time

Functions

func InstallBashCompletion

func InstallBashCompletion(root *cli.Command) error

InstallBashCompletion install bash_completion

Types

type CSVRecord

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

CSV reads one csv record

func (CSVRecord) Bools

func (d CSVRecord) Bools() ([]bool, error)

func (*CSVRecord) Decode

func (d *CSVRecord) Decode(s string) error

func (CSVRecord) Floats

func (d CSVRecord) Floats() ([]float64, error)

func (CSVRecord) Ints

func (d CSVRecord) Ints() ([]int64, error)

func (CSVRecord) Strings

func (d CSVRecord) Strings() []string

func (CSVRecord) Uints

func (d CSVRecord) Uints() ([]uint64, error)

type Duration

type Duration struct {
	time.Duration
}

Duration wrap time.Duration

Example

This example demonstrates uage of Duration decoder

package main

import (
	"github.com/franchb/cli"
	"github.com/franchb/cli/ext"
)

func main() {
	type argT struct {
		Duration ext.Duration `cli:"d"`
	}
	for _, args := range [][]string{
		[]string{"app", "-d10s"},
		[]string{"app", "-d10ms"},
	} {
		cli.RunWithArgs(new(argT), args, func(ctx *cli.Context) error {
			argv := ctx.Argv().(*argT)
			ctx.String("duration=%v\n", argv.Duration.Duration)
			return nil
		})
	}
}

Output:

duration=10s
duration=10ms

func (*Duration) Decode

func (d *Duration) Decode(s string) error

func (Duration) Encode

func (d Duration) Encode() string

type File

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

File reads data from file or stdin(if filename is empty)

Example

This example demonstrates usage of File decoder

package main

import (
	"io/ioutil"
	"os"

	"github.com/franchb/cli"
	"github.com/franchb/cli/ext"
)

func main() {
	type argT struct {
		Data ext.File `cli:"f"`
	}
	filename := "test.txt"
	ioutil.WriteFile(filename, []byte("hello, File decoder"), 0644)
	defer os.Remove(filename)

	args := []string{"app", "-f", filename}
	cli.RunWithArgs(new(argT), args, func(ctx *cli.Context) error {
		argv := ctx.Argv().(*argT)
		ctx.String("%s\n", argv.Data)
		return nil
	})
}

Output:

hello, File decoder

func (File) Data

func (f File) Data() []byte

func (*File) Decode

func (f *File) Decode(s string) error

func (File) Encode

func (f File) Encode() string

func (File) String

func (f File) String() string

type PidFile

type PidFile string

PidFile

func (*PidFile) Decode

func (pid *PidFile) Decode(s string) error

func (PidFile) New

func (pid PidFile) New() error

func (PidFile) Remove

func (pid PidFile) Remove() error

func (PidFile) String

func (pid PidFile) String() string

type Reader

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

Reader

func (Reader) Close

func (r Reader) Close() error

func (*Reader) Decode

func (r *Reader) Decode(s string) error

func (Reader) IsStdin

func (r Reader) IsStdin() bool

func (Reader) Name

func (r Reader) Name() string

func (Reader) Read

func (r Reader) Read(data []byte) (n int, err error)

Read implementes io.Reader

func (*Reader) SetReader

func (r *Reader) SetReader(reader io.Reader)

SetReader replaces the native reader

type Time

type Time struct {
	time.Time
	// contains filtered or unexported fields
}

Time wrap time.Time

Example

This example demonstrates usage of Time decoder

package main

import (
	"time"

	"github.com/franchb/cli"
	"github.com/franchb/cli/ext"
)

func main() {
	type argT struct {
		When ext.Time `cli:"w"`
	}
	for _, args := range [][]string{
		[]string{"app", "-w", "2016-01-02 12:12:22"},
		[]string{"app", "-w2016-01-02"},
	} {
		cli.RunWithArgs(new(argT), args, func(ctx *cli.Context) error {
			argv := ctx.Argv().(*argT)
			ctx.String("time=%s\n", argv.When.Time.Format(time.ANSIC))
			return nil
		})
	}
}

Output:

time=Sat Jan  2 12:12:22 2016
time=Sat Jan  2 00:00:00 2016

func (*Time) Decode

func (t *Time) Decode(s string) error

func (Time) Encode

func (t Time) Encode() string

func (Time) IsSet

func (t Time) IsSet() bool

type Writer

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

Writer

func (*Writer) Close

func (w *Writer) Close() error

func (*Writer) Decode

func (w *Writer) Decode(s string) error

func (Writer) IsStdout

func (w Writer) IsStdout() bool

func (*Writer) Name

func (w *Writer) Name() string

func (*Writer) SetWriter

func (w *Writer) SetWriter(writer io.Writer)

SetWriter replaces the native writer

func (*Writer) Write

func (w *Writer) Write(data []byte) (n int, err error)

Write implementes io.Writer interface