Struct beancount_parser::BeancountFile

#[non_exhaustive]
pub struct BeancountFile<D> {
    pub options: Vec<BeanOption>,
    pub includes: Vec<PathBuf>,
    pub directives: Vec<Directive<D>>,
}

Main struct representing a parsed beancount file.

To get an instance of this, use parse.

For an example, look at the root crate documentation.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

options: Vec<BeanOption>

List of beancount options

See: https://beancount.github.io/docs/beancount_language_syntax.html#options

includes: Vec<PathBuf>

Paths of include directives

See: https://beancount.github.io/docs/beancount_language_syntax.html#includes

directives: Vec<Directive<D>>

List of Directive found in the file

Implementations

impl<D> BeancountFile<D>

pub fn option(&self, key: &str) -> Option<&str>

Returns the first value found for the option

If the option is declared multiple times, this function returns the first one found.

See Self::options to get all declared options.

Syntax: https://beancount.github.io/docs/beancount_language_syntax.html#options

Example

use beancount_parser::BeancountFile;
let input = r#"
option "favorite_color" "blue"
option "operating_currency" "CHF"
option "operating_currency" "PLN"
"#;
let beancount: BeancountFile<f64> = input.parse().unwrap();
assert_eq!(beancount.option("favorite_color"), Some("blue"));
assert_eq!(beancount.option("operating_currency"), Some("CHF"));
assert_eq!(beancount.option("foo"), None);

Trait Implementations

impl<D: Clone> Clone for BeancountFile<D>

fn clone(&self) -> BeancountFile<D>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<D: Debug> Debug for BeancountFile<D>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<D> Default for BeancountFile<D>

fn default() -> Self

Returns the “default value” for a type.

impl<D> Extend<Entry<D>> for BeancountFile<D>

fn extend<T: IntoIterator<Item = Entry<D>>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<D> FromIterator<Entry<D>> for BeancountFile<D>

fn from_iter<T: IntoIterator<Item = Entry<D>>>(iter: T) -> Self

Creates a value from an iterator.

impl<D: Decimal> FromStr for BeancountFile<D>

type Err = Error

The associated error which can be returned from parsing.

fn from_str(input: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.