flags

Documentation

Index

• func OpenFile(p string) (*bufio.Reader, error)
• type AccountFlag
  • func (cf *AccountFlag) Set(v string) error
  • func (cf AccountFlag) String() string
  • func (cf AccountFlag) Type() string
  • func (cf AccountFlag) Value(ctx journal.Context) (*journal.Account, error)
  • func (cf AccountFlag) ValueWithDefault(ctx journal.Context, def *journal.Account) (*journal.Account, error)
• type CommodityFlag
  • func (cf *CommodityFlag) Set(v string) error
  • func (cf CommodityFlag) String() string
  • func (cf CommodityFlag) Type() string
  • func (cf CommodityFlag) Value(ctx journal.Context) (*journal.Commodity, error)
• type DateFlag
  • func (tf *DateFlag) Set(v string) error
  • func (tf DateFlag) String() string
  • func (tf DateFlag) Type() string
  • func (tf DateFlag) Value() time.Time
  • func (tf DateFlag) ValueOr(t time.Time) time.Time
• type IntervalFlags
  • func (pf *IntervalFlags) Setup(cmd *cobra.Command, def date.Interval)
  • func (pf IntervalFlags) Value() date.Interval
• type MappingFlag
  • func (cf *MappingFlag) Set(v string) error
  • func (cf MappingFlag) String() string
  • func (cf MappingFlag) Type() string
  • func (cf *MappingFlag) Value() journal.AccountMapping
• type PeriodFlag
  • func (pf *PeriodFlag) Setup(cmd *cobra.Command, def date.Period)
  • func (pf *PeriodFlag) Value() date.Period
• type RegexFlag
  • func (rf *RegexFlag) Regex() regex.Regexes
  • func (rf *RegexFlag) Set(v string) error
  • func (rf RegexFlag) String() string
  • func (rf RegexFlag) Type() string

Functions

func OpenFile

func OpenFile(p string) (*bufio.Reader, error)

OpenFile opens the file at the given path as a buffered reader.

Types

type AccountFlag

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

AccountFlag manages a flag to parse a commodity.

func (*AccountFlag) Set

func (cf *AccountFlag) Set(v string) error

Set implements pflag.Value.

func (AccountFlag) String

func (cf AccountFlag) String() string

Value returns the flag value.

func (AccountFlag) Type

func (cf AccountFlag) Type() string

Type implements pflag.Value.

func (AccountFlag) Value

func (cf AccountFlag) Value(ctx journal.Context) (*journal.Account, error)

Value returns the account.

func (AccountFlag) ValueWithDefault

func (cf AccountFlag) ValueWithDefault(ctx journal.Context, def *journal.Account) (*journal.Account, error)

ValueWithDefault returns the account. If no account has been specified, the default is returned.

type CommodityFlag

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

CommodityFlag manages a flag to parse a commodity.

func (*CommodityFlag) Set

func (cf *CommodityFlag) Set(v string) error

Set implements pflag.Value.

func (CommodityFlag) String

func (cf CommodityFlag) String() string

Value returns the flag value.

func (CommodityFlag) Type

func (cf CommodityFlag) Type() string

Type implements pflag.Value.

func (CommodityFlag) Value

func (cf CommodityFlag) Value(ctx journal.Context) (*journal.Commodity, error)

Value returns the commodity.

type DateFlag

type DateFlag time.Time

DateFlag manages a flag to determine a date.

func (*DateFlag) Set

func (tf *DateFlag) Set(v string) error

Set implements pflag.Value.

func (DateFlag) String

func (tf DateFlag) String() string

func (DateFlag) Type

func (tf DateFlag) Type() string

Type implements pflag.Value.

func (DateFlag) Value

func (tf DateFlag) Value() time.Time

Value returns the flag value.

func (DateFlag) ValueOr

func (tf DateFlag) ValueOr(t time.Time) time.Time

type IntervalFlags

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

IntervalFlags manages multiple flags to determine a time period.

func (*IntervalFlags) Setup

func (pf *IntervalFlags) Setup(cmd *cobra.Command, def date.Interval)

Setup configures the flags.

func (IntervalFlags) Value

func (pf IntervalFlags) Value() date.Interval

Value returns the period.

type MappingFlag

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

MappingFlag manages a flag of type -c1,<regex>.

func (*MappingFlag) Set

func (cf *MappingFlag) Set(v string) error

Set implements pflag.Value.

func (MappingFlag) String

func (cf MappingFlag) String() string

func (MappingFlag) Type

func (cf MappingFlag) Type() string

Type implements pflag.Value.

func (*MappingFlag) Value

func (cf *MappingFlag) Value() journal.AccountMapping

Value returns the value of this flag.

type PeriodFlag

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

func (*PeriodFlag) Setup

func (pf *PeriodFlag) Setup(cmd *cobra.Command, def date.Period)

func (*PeriodFlag) Value

func (pf *PeriodFlag) Value() date.Period

type RegexFlag

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

RegexFlag manages a flag to get a regex.

func (*RegexFlag) Regex

func (rf *RegexFlag) Regex() regex.Regexes

func (*RegexFlag) Set

func (rf *RegexFlag) Set(v string) error

Set implements pflag.Set.

func (RegexFlag) String

func (rf RegexFlag) String() string

func (RegexFlag) Type

func (rf RegexFlag) Type() string

Type implements pflag.Type.