balance

Documentation

Index

• type AccountCloser
  • func (vtc AccountCloser) Process(d *ledger.Day) error
• type AccountOpener
  • func (a AccountOpener) Process(d *ledger.Day) error
• type Accounts
  • func (oa Accounts) Close(a *ledger.Account) error
  • func (oa Accounts) Copy() Accounts
  • func (oa Accounts) IsOpen(a *ledger.Account) bool
  • func (oa Accounts) Open(a *ledger.Account) error
• type Asserter
  • func (as Asserter) Process(d *ledger.Day) error
• type Balance
  • func Diffs(bals []*Balance) []*Balance
  • func New(ctx ledger.Context, valuation *ledger.Commodity) *Balance
  • func (b *Balance) Copy() *Balance
  • func (b *Balance) Minus(bo *Balance)
• type Builder
  • func (b Builder) Build(l ledger.Ledger) ([]*Balance, error)
• type CommodityAccount
  • func (p CommodityAccount) Less(p1 CommodityAccount) bool
• type DateUpdater
  • func (a DateUpdater) Process(d *ledger.Day) error
• type Error
  • func (be Error) Error() string
• type PeriodCloser
  • func (as PeriodCloser) Process(d *ledger.Day) error
• type PriceUpdater
  • func (a *PriceUpdater) Initialize(_ ledger.Ledger) error
  • func (a *PriceUpdater) Process(d *ledger.Day) error
• type Snapshotter
  • func (a *Snapshotter) Finalize() error
  • func (a *Snapshotter) Initialize(l ledger.Ledger) error
  • func (a *Snapshotter) Process(d *ledger.Day) error
• type TransactionBooker
  • func (tb TransactionBooker) Process(d *ledger.Day) error
• type TransactionValuator
  • func (as TransactionValuator) Process(d *ledger.Day) error
• type ValuationTransactionComputer
  • func (vtc ValuationTransactionComputer) Process(d *ledger.Day) error
• type ValueBooker
  • func (tb ValueBooker) Process(d *ledger.Day) error

Types

type AccountCloser

type AccountCloser struct {
	Balance *Balance
}

AccountCloser closes accounts.

func (AccountCloser) Process

func (vtc AccountCloser) Process(d *ledger.Day) error

Process implements Processor.

type AccountOpener

type AccountOpener struct {
	Balance *Balance
}

AccountOpener keeps track of open accounts.

func (AccountOpener) Process

func (a AccountOpener) Process(d *ledger.Day) error

Process implements Processor.

type Accounts

type Accounts map[*ledger.Account]bool

Accounts keeps track of open accounts.

func (Accounts) Close

func (oa Accounts) Close(a *ledger.Account) error

Close closes an account.

func (Accounts) Copy

func (oa Accounts) Copy() Accounts

Copy copies accounts.

func (Accounts) IsOpen

func (oa Accounts) IsOpen(a *ledger.Account) bool

IsOpen returns whether an account is open.

func (Accounts) Open

func (oa Accounts) Open(a *ledger.Account) error

Open opens an account.

type Asserter

type Asserter struct {
	Balance *Balance
}

Asserter keeps track of open accounts.

func (Asserter) Process

func (as Asserter) Process(d *ledger.Day) error

Process implements Processor.

type Balance

type Balance struct {
	Date             time.Time
	Amounts, Values  map[CommodityAccount]decimal.Decimal
	Accounts         Accounts
	Context          ledger.Context
	Valuation        *ledger.Commodity
	NormalizedPrices prices.NormalizedPrices
}

Balance represents a balance for accounts at the given date.

func Diffs

func Diffs(bals []*Balance) []*Balance

Diffs creates the difference balances for the given slice of balances. The returned slice is one element smaller than the input slice. The balances are mutated.

func New

func New(ctx ledger.Context, valuation *ledger.Commodity) *Balance

New creates a new balance.

func (*Balance) Copy

func (b *Balance) Copy() *Balance

Copy deeply copies the balance

func (*Balance) Minus

func (b *Balance) Minus(bo *Balance)

Minus mutably subtracts the given balance from the receiver.

type Builder

type Builder struct {
	From, To    *time.Time
	Period      date.Period
	Last        int
	Valuation   *ledger.Commodity
	Close, Diff bool
}

Builder builds a sequence of balances.

func (Builder) Build

func (b Builder) Build(l ledger.Ledger) ([]*Balance, error)

Build builds a sequence of balances.

type CommodityAccount

type CommodityAccount struct {
	Account   *ledger.Account
	Commodity *ledger.Commodity
}

CommodityAccount represents a position.

func (CommodityAccount) Less

func (p CommodityAccount) Less(p1 CommodityAccount) bool

Less establishes a partial ordering of commodity accounts.

type DateUpdater

type DateUpdater struct {
	Balance *Balance
}

DateUpdater keeps track of open accounts.

func (DateUpdater) Process

func (a DateUpdater) Process(d *ledger.Day) error

Process implements Processor.

type Error

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

Error is an error.

func (Error) Error

func (be Error) Error() string

type PeriodCloser

type PeriodCloser struct {
	Balance *Balance
}

PeriodCloser closes the accounting period.

func (PeriodCloser) Process

func (as PeriodCloser) Process(d *ledger.Day) error

Process implements Processor.

type PriceUpdater

type PriceUpdater struct {
	Balance *Balance
	// contains filtered or unexported fields
}

PriceUpdater keeps track of prices.

func (*PriceUpdater) Initialize

func (a *PriceUpdater) Initialize(_ ledger.Ledger) error

Initialize implements Initializer.

func (*PriceUpdater) Process

func (a *PriceUpdater) Process(d *ledger.Day) error

Process implements Processor.

type Snapshotter

type Snapshotter struct {
	Balance  *Balance
	From, To *time.Time
	Last     int
	Diff     bool
	Period   date.Period
	Result   *[]*Balance
	// contains filtered or unexported fields
}

Snapshotter keeps track of open accounts.

func (*Snapshotter) Finalize

func (a *Snapshotter) Finalize() error

Finalize implements Finalizer.

func (*Snapshotter) Initialize

func (a *Snapshotter) Initialize(l ledger.Ledger) error

Initialize implements Initializer.

func (*Snapshotter) Process

func (a *Snapshotter) Process(d *ledger.Day) error

Process implements Processor.

type TransactionBooker

type TransactionBooker struct {
	Balance *Balance
}

TransactionBooker books transaction amounts.

func (TransactionBooker) Process

func (tb TransactionBooker) Process(d *ledger.Day) error

Process implements Processor.

type TransactionValuator

type TransactionValuator struct {
	Balance *Balance
}

TransactionValuator valuates transactions.

func (TransactionValuator) Process

func (as TransactionValuator) Process(d *ledger.Day) error

Process implements Processor.

type ValuationTransactionComputer

type ValuationTransactionComputer struct {
	Balance *Balance
}

ValuationTransactionComputer valuates transactions.

func (ValuationTransactionComputer) Process

func (vtc ValuationTransactionComputer) Process(d *ledger.Day) error

Process implements Processor.

type ValueBooker

type ValueBooker struct {
	Balance *Balance
}

ValueBooker books amounts for value directives.

func (ValueBooker) Process

func (tb ValueBooker) Process(d *ledger.Day) error

Process implements Processor.