process

Documentation

Index

• type ASTBuilder
  • func (pr *ASTBuilder) BuildAST(ctx context.Context, inCh <-chan ast.Directive) (<-chan *ast.AST, <-chan error)
• type ASTExpander
  • func (pr *ASTExpander) ExpandAndFilterAST(ctx context.Context, inCh <-chan *ast.AST) (<-chan *ast.AST, <-chan error)
• type Differ
  • func (pf Differ) ProcessStream(ctx context.Context, inCh <-chan *val.Day) (<-chan *val.Day, <-chan error)
• type Error
  • func (be Error) Error() string
• type PASTBuilder
  • func (pr *PASTBuilder) ProcessAST(ctx context.Context, inCh <-chan *ast.AST) (<-chan *past.Day, <-chan error)
• type PeriodFilter
  • func (pf PeriodFilter) ProcessStream(ctx context.Context, inCh <-chan *val.Day) (<-chan *val.Day, <-chan error)
• type PriceUpdater
  • func (pr PriceUpdater) ProcessStream(ctx context.Context, inCh <-chan *past.Day) (<-chan *val.Day, <-chan error)
• type Valuator
  • func (pr *Valuator) ProcessStream(ctx context.Context, inCh <-chan *val.Day) (chan *val.Day, chan error)

Types

type ASTBuilder

type ASTBuilder struct {
	Context journal.Context
}

ASTBuilder builds an abstract syntax tree.

func (*ASTBuilder) BuildAST

func (pr *ASTBuilder) BuildAST(ctx context.Context, inCh <-chan ast.Directive) (<-chan *ast.AST, <-chan error)

BuildAST reads directives from the given channel and builds a Ledger if successful.

type ASTExpander

type ASTExpander struct {
	Expand bool
	Filter journal.Filter
}

ASTExpander expands and filters the given AST.

func (*ASTExpander) ExpandAndFilterAST

func (pr *ASTExpander) ExpandAndFilterAST(ctx context.Context, inCh <-chan *ast.AST) (<-chan *ast.AST, <-chan error)

ExpandAndFilterAST processes the given AST.

type Differ

type Differ struct {
	Diff bool
}

Differ filters the incoming days according to the dates specified.

func (Differ) ProcessStream

func (pf Differ) ProcessStream(ctx context.Context, inCh <-chan *val.Day) (<-chan *val.Day, <-chan error)

ProcessStream does the filtering.

type Error

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

Error is an error.

func (Error) Error

func (be Error) Error() string

type PASTBuilder

type PASTBuilder struct {

	// The context of this journal.
	Context journal.Context
}

PASTBuilder processes ASTs.

func (*PASTBuilder) ProcessAST

func (pr *PASTBuilder) ProcessAST(ctx context.Context, inCh <-chan *ast.AST) (<-chan *past.Day, <-chan error)

ProcessAST processes an AST to a stream of past.Day. It check assertions and the usage of open and closed accounts. It will also resolve Value directives and convert them to transactions.

type PeriodFilter

type PeriodFilter struct {
	From, To time.Time
	Interval date.Interval
	Last     int
	Diff     bool
}

PeriodFilter filters the incoming days according to the dates specified.

func (PeriodFilter) ProcessStream

func (pf PeriodFilter) ProcessStream(ctx context.Context, inCh <-chan *val.Day) (<-chan *val.Day, <-chan error)

ProcessStream does the filtering.

type PriceUpdater

type PriceUpdater struct {
	Context   journal.Context
	Valuation *journal.Commodity
}

PriceUpdater updates the prices in a stream of days.

func (PriceUpdater) ProcessStream

func (pr PriceUpdater) ProcessStream(ctx context.Context, inCh <-chan *past.Day) (<-chan *val.Day, <-chan error)

ProcessStream computes prices.

type Valuator

type Valuator struct {
	Context   journal.Context
	Valuation *journal.Commodity
}

Valuator produces valuated days.

func (*Valuator) ProcessStream

func (pr *Valuator) ProcessStream(ctx context.Context, inCh <-chan *val.Day) (chan *val.Day, chan error)

ProcessStream computes prices.