model

Documentation

Index

• type Assertion
  • func (a Assertion) WriteTo(w io.Writer) (int64, error)
• type Close
  • func (c Close) WriteTo(b io.Writer) (int64, error)
• type CommodityAccount
  • func NewCommodityAccount(a *accounts.Account, c *commodities.Commodity) CommodityAccount
  • func (p CommodityAccount) Account() *accounts.Account
  • func (p CommodityAccount) Commodity() *commodities.Commodity
  • func (p CommodityAccount) Less(p1 CommodityAccount) bool
• type Directive
  • func NewDirective(pos Range, date time.Time) Directive
  • func (d Directive) Date() time.Time
  • func (d Directive) Position() Range
• type FilePosition
  • func (p FilePosition) String() string
• type Include
  • func (i Include) WriteTo(w io.Writer) (int64, error)
• type Lot
  • func (l Lot) WriteTo(b io.Writer) (int64, error)
• type Open
  • func (o Open) WriteTo(b io.Writer) (int64, error)
• type Position
• type Posting
  • func NewPosting(crAccount, drAccount *accounts.Account, commodity *commodities.Commodity, ...) *Posting
  • func (t Posting) WriteTo(b io.Writer) (int64, error)
• type Price
  • func (p Price) WriteTo(w io.Writer) (int64, error)
• type Range
• type Tag
  • func (t Tag) String() string
• type Transaction
  • func (t Transaction) WriteTo(b io.Writer) (int64, error)
• type Value
  • func (a Value) WriteTo(w io.Writer) (int64, error)

Types

type Assertion

type Assertion struct {
	Directive
	Account   *accounts.Account
	Amount    decimal.Decimal
	Commodity *commodities.Commodity
}

Assertion represents a balance assertion.

func (Assertion) WriteTo

func (a Assertion) WriteTo(w io.Writer) (int64, error)

WriteTo pretty-prints an assertion directive.

type Close

type Close struct {
	Directive
	Account *accounts.Account
}

Close represents a close command.

func (Close) WriteTo

func (c Close) WriteTo(b io.Writer) (int64, error)

WriteTo pretty-prints a close directive.

type CommodityAccount

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

CommodityAccount represents a position.

func NewCommodityAccount

func NewCommodityAccount(a *accounts.Account, c *commodities.Commodity) CommodityAccount

NewCommodityAccount creates a new position

func (CommodityAccount) Account

func (p CommodityAccount) Account() *accounts.Account

Account returns the account.

func (CommodityAccount) Commodity

func (p CommodityAccount) Commodity() *commodities.Commodity

Commodity returns the commodity.

func (CommodityAccount) Less

func (p CommodityAccount) Less(p1 CommodityAccount) bool

Less establishes a partial ordering of commodity accounts.

type Directive

type Directive struct {
	Pos Range
	// contains filtered or unexported fields
}

Directive is a directive in a journal.

func NewDirective

func NewDirective(pos Range, date time.Time) Directive

NewDirective returns a new directive.

func (Directive) Date

func (d Directive) Date() time.Time

Date returns the date.

func (Directive) Position

func (d Directive) Position() Range

Position returns the position.

type FilePosition

type FilePosition struct {
	Path                           string
	BytePos, RunePos, Line, Column int
}

FilePosition is a position of a character in a text file.

func (FilePosition) String

func (p FilePosition) String() string

type Include

type Include struct {
	Directive
	Path string
}

Include represents an include directive.

func (Include) WriteTo

func (i Include) WriteTo(w io.Writer) (int64, error)

WriteTo pretty-prints an include directive

type Lot

type Lot struct {
	Date      time.Time
	Label     string
	Price     float64
	Commodity *commodities.Commodity
}

Lot represents a lot.

func (Lot) WriteTo

func (l Lot) WriteTo(b io.Writer) (int64, error)

WriteTo pretty-prints a posting.

type Open

type Open struct {
	Directive
	Account *accounts.Account
}

Open represents an open command.

func (Open) WriteTo

func (o Open) WriteTo(b io.Writer) (int64, error)

WriteTo pretty-prints an open directive.

type Position

type Position struct {
	CommodityAccount
	Amounts amount.Vec
}

Position is a position.

type Posting

type Posting struct {
	Amount        amount.Amount
	Credit, Debit *accounts.Account
	Commodity     *commodities.Commodity
	Lot           *Lot
	Tag           *Tag
}

Posting represents a posting.

func NewPosting

func NewPosting(crAccount, drAccount *accounts.Account, commodity *commodities.Commodity, amt decimal.Decimal, tag *Tag) *Posting

NewPosting creates a new posting from the given parameters. If amount is negative, it will be inverted and the accounts reversed.

func (Posting) WriteTo

func (t Posting) WriteTo(b io.Writer) (int64, error)

WriteTo pretty-prints a posting.

type Price

type Price struct {
	Directive
	Commodity *commodities.Commodity
	Target    *commodities.Commodity
	Price     float64
}

Price represents a price command.

func (Price) WriteTo

func (p Price) WriteTo(w io.Writer) (int64, error)

WriteTo pretty-prints a Price directive.

type Range

type Range struct {
	Start, End FilePosition
}

Range describes a range in the source code.

type Tag

type Tag string

Tag represents a tag for a transaction or booking.

func (Tag) String

func (t Tag) String() string

String pretty-prints a tag.

type Transaction

type Transaction struct {
	Directive
	Description string
	Tags        []Tag
	Postings    []*Posting
}

Transaction represents a transaction.

func (Transaction) WriteTo

func (t Transaction) WriteTo(b io.Writer) (int64, error)

WriteTo pretty-prints a transaction.

type Value

type Value struct {
	Directive
	Account   *accounts.Account
	Amount    decimal.Decimal
	Commodity *commodities.Commodity
}

Value represents a value directive.

func (Value) WriteTo

func (a Value) WriteTo(w io.Writer) (int64, error)

WriteTo pretty-prints an assertion directive.