Module types

Module types 

Source

Structs§

Account
A Beancount account, simply a string after account type validation.
AccountError
Error type for AccountTypeName creation.
AccountName
One component of a colon-separated account.
AccountNameError
Error type for AccountName creation.
AccountTypeIter
An iterator over the variants of AccountType
AccountTypeName
A validated name for an account type.
AccountTypeNameError
Error type for AccountTypeName creation.
Amount
A ExprValue and Currency.
AmountWithTolerance
An Amount with optional tolerance.
AnnotatedErrorOrWarning
Annotated error or warning
Balance
A Beancount balance directive, without the common Directive fields.
BookingIter
An iterator over the variants of Booking
Close
A Beancount close directive, without the common Directive fields.
Commodity
A Beancount commodity directive, without the common Directive fields.
CostSpec
A cost specification.
CostSpecError
Error type for CostSpec creation.
CostSpecErrors
Multiple errors arising from creation of a CostSpec.
Currency
A Beancount currency.
CurrencyError
Error type for Currency creation.
Directive
A Beancount directive of a particular DirectiveVariant.
Document
A Beancount document directive, without the common Directive fields.
ErrorKind
Marker type for ErrorOrWarning error.
ErrorOrWarning
Error or warning, according to the marker type with which it is instantiated.
Event
A Beancount event directive, without the common Directive fields.
ExprValue
An Expr which has been evaluated.
FlagLetter
A flag other than one of the builtin ones.
FlagLetterError
Error type for invalid FlagLetter.
Key
A key for a Metadata MetaValue.
KeyError
Error type for Key creation.
Link
A link.
LooseAmount
An amount where each element of ExprValue and Currency may not actually be specified.
Metadata
Metadata associated with a Directive or a Posting.
Note
A Beancount note directive, without the common Directive fields.
Open
A Beancount open directive, without the common Directive fields.
Pad
A Beancount pad directive, without the common Directive fields.
Plugin
A Beancount plugin pragma.
PluginProcessingModeIter
An iterator over the variants of PluginProcessingMode
Posting
A single posting within a Transaction.
Price
A Beancount price directive, without the common Directive fields.
Query
A Beancount query directive, without the common Directive fields.
SourceId
Identifies a source file.
Spanned
A Spanned item is one located within its source file. The span is invisible with respect to equality and hashing.
Subaccount
an account without the account type prefix
Tag
A tag.
TagOrLinkIdentifier
The validated identifier part of a Tag or Link without the # or ^ prefix.
TagOrLinkIdentifierError
Error type for TagOrLinkIdentifier creation.
Transaction
A Beancount transaction directive, without the common Directive fields.
WarningKind
Marker type for ErrorOrWarning warning.

Enums§

AccountType
Top-level account type, the prefix of any fully-qualified Account.
Booking
The booking method for an account.
CompoundAmount
An amount which specifies a total or per-unit value or both, with or without a currency, or simply just a Currency.
CompoundExprValue
An ExprValue which quantifies a total or per-unit, or both.
DirectiveVariant
A Beancount directive, without the fields common to all, which belong to Directive.
Expr
A numeric expression which respects standard operator precedence.
Flag
A flag on a Posting or Transaction.
MetaValue
A value of metadata key/value.
PluginProcessingMode
PriceSpec
An amount which specifies a total or per-unit value, with or without a currency, or simply just a Currency. Unlike a CompoundAmount it is forbidden to have both total and per-unit.
ScopedExprValue
An ExprValue which quantifies either a total or per-unit, but not both.
SimpleValue
One possible type of MetaValue.

Traits§

ElementType
Implemented by any element, for access to its kind in error reporting.
ErrorOrWarningKind
Trait for formatting of Error separately from Warning.
OptionalItem
convenenience trait for dealing with Option<&Spanned>

Functions§

spanned

Type Aliases§

AnnotatedError
AnnotatedWarning
Error
The type of errors returned by the parser. All that can usefully be done with these is write them via BeancountSources.
Span
Identifies a span of text within its source file.
Warning
The type of warnings returned by the parser. All that can usefully be done with these is write them via BeancountSources.