[][src]Crate bookkeeping

This is a new rustacean's first open source crate. It is made with the intention of serving as the go-to bookkeeping crate. To get there, reviews from knowledgeable rustaceans seem necessary, so if you are one, then consider giving this crate your full attention for a while and leave your comments as a contribution to the community.

This crate tries to model the very basics of the bookkeeping activity.

It doesn't make assumptions regarding what metadata is attached to anything and allows you to define your own types for that. It also lets you determine how moves in an account are sorted, by providing your own sorting implementation that is based on your metadata.

Imbalance is prevented as much as possible, first by the data structures and further entirely, by runtime.

It attempts to provide an API that is nice to work with and also minimizes possible points of panic.

It is oblivious to the concept of a currency. Therefore, there are no decimal places, minor and major units. There is only the concept of a Unit, as in unit of measurement, which the user may associate with some currency implementation via its metadata.

The most obvious todo items are:

  • Grouping of moves to represent transactions.
  • Editing/removing items other than metadata.
  • Caching of balance calculations.

Structs

Account

Represents an account.

Balance

Represents a balance, yet not necessarily the current balance.

Book

Entry point to the API and retains ownership of accounts, units and moves.

Move

Represents a move of a Sum of Units from one account to another.

Sum

Represents amounts of any number of units.

Unit

Represents a unit of measurement. Will most commonly represent the minor unit of a currency.

Traits

Metadata

Implement this trait to specify the type of metadata for each of the bookkeeping entities.