Skip to main content

CurrencyAccountsPlugin

Struct CurrencyAccountsPlugin 

Source
pub struct CurrencyAccountsPlugin { /* private fields */ }
Expand description

Plugin that auto-generates currency trading account postings.

Implements the currency trading accounts method as in Python beancount’s beancount.plugins.currency_accounts. For transactions that mix multiple currencies and use price annotations, this plugin:

  1. Groups postings by cost.currency (if the posting has a cost) or units.currency (otherwise). Price currency is never used as the group key — this matches Python’s group_postings_by_weight_currency.
  2. If there is at least one price annotation in the transaction and there are two or more distinct group keys, inserts a neutralizing posting for each group. The neutralizing posting goes to <base>:<group_key> and carries the negated weight inventory of that group (denominated in the weight/cost currency, which may differ from the group key).
  3. Unlike Python’s plugin, does NOT strip price annotations from the original postings. Python strips them because its pipeline runs plugins before booking; rustledger runs booking first, so stripping prices would cause balance-check failures (E3001) in the post-plugin validator.
  4. Emits open directives at the earliest transaction date for all newly created currency trading accounts.

Implementations§

Source§

impl CurrencyAccountsPlugin

Source

pub fn new() -> Self

Create with default base account.

Source

pub const fn with_base_account(base_account: String) -> Self

Create with custom base account.

Trait Implementations§

Source§

impl Default for CurrencyAccountsPlugin

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl NativePlugin for CurrencyAccountsPlugin

Source§

fn name(&self) -> &'static str

Plugin name.
Source§

fn description(&self) -> &'static str

Plugin description.
Source§

fn process(&self, input: PluginInput) -> PluginOutput

Process directives and return modified directives + errors.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V