Struct Transaction 

pub struct Transaction {
    pub date: NaiveDate,
    pub flag: char,
    pub payee: Option<InternedStr>,
    pub narration: InternedStr,
    pub tags: Vec<InternedStr>,
    pub links: Vec<InternedStr>,
    pub meta: Metadata,
    pub postings: Vec<Posting>,
}

A transaction directive.

Transactions are the most common directive type. They record transfers between accounts and must balance (sum of all postings equals zero).

Fields

date: NaiveDate

Transaction date

flag: char

Transaction flag (* or !)

payee: Option<InternedStr>

Payee (optional)

narration: InternedStr

Narration (description)

tags: Vec<InternedStr>

Tags attached to this transaction

links: Vec<InternedStr>

Links attached to this transaction

meta: Metadata

Transaction metadata

postings: Vec<Posting>

Postings (account entries)

Implementations

impl Transaction

pub fn new(date: NaiveDate, narration: impl Into<InternedStr>) -> Self

Create a new transaction.

pub const fn with_flag(self, flag: char) -> Self

Set the flag.

pub fn with_payee(self, payee: impl Into<InternedStr>) -> Self

Set the payee.

pub fn with_tag(self, tag: impl Into<InternedStr>) -> Self

Add a tag.

pub fn with_link(self, link: impl Into<InternedStr>) -> Self

Add a link.

pub fn with_posting(self, posting: Posting) -> Self

Add a posting.

pub const fn is_complete(&self) -> bool

Check if this transaction is marked as complete (*).

pub const fn is_incomplete(&self) -> bool

Check if this transaction is marked as incomplete/pending (!).

pub const fn is_pending(&self) -> bool

Check if this transaction is marked as pending (!). Alias for is_incomplete.

pub const fn is_pad_generated(&self) -> bool

Check if this transaction was generated by a pad directive (P).

pub const fn is_summarization(&self) -> bool

Check if this is a summarization transaction (S).

pub const fn is_transfer(&self) -> bool

Check if this is a transfer transaction (T).

pub const fn is_conversion(&self) -> bool

Check if this is a currency conversion transaction (C).

pub const fn is_unrealized(&self) -> bool

Check if this is an unrealized gains transaction (U).

pub const fn is_return(&self) -> bool

Check if this is a return/dividend transaction (R).

pub const fn is_merge(&self) -> bool

Check if this is a merge transaction (M).

pub const fn is_bookmarked(&self) -> bool

Check if this transaction is bookmarked (#).

pub const fn needs_investigation(&self) -> bool

Check if this transaction needs investigation (?).

pub const fn is_valid_flag(flag: char) -> bool

Check if the given character is a valid transaction flag.

Trait Implementations

impl Archive for Transaction

where AsNaiveDate: ArchiveWith<NaiveDate>, char: Archive, AsOptionInternedStr: ArchiveWith<Option<InternedStr>>, AsInternedStr: ArchiveWith<InternedStr>, AsVecInternedStr: ArchiveWith<Vec<InternedStr>>, Metadata: Archive, Vec<Posting>: Archive,

type Archived = ArchivedTransaction

The archived representation of this type.

type Resolver = TransactionResolver

The resolver for this type. It must contain all the additional information from serializing needed to make the archived type from the normal type.

fn resolve(&self, resolver: Self::Resolver, out: Place<Self::Archived>)

Creates the archived version of this value at the given position and writes it to the given output.

const COPY_OPTIMIZATION: CopyOptimization<Self> = _

An optimization flag that allows the bytes of this type to be copied directly to a writer instead of calling serialize.

impl Clone for Transaction

fn clone(&self) -> Transaction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Transaction

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Transaction

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<__D: Fallible + ?Sized> Deserialize<Transaction, __D> for Archived<Transaction>

where AsNaiveDate: ArchiveWith<NaiveDate> + DeserializeWith<<AsNaiveDate as ArchiveWith<NaiveDate>>::Archived, NaiveDate, __D>, char: Archive, <char as Archive>::Archived: Deserialize<char, __D>, AsOptionInternedStr: ArchiveWith<Option<InternedStr>> + DeserializeWith<<AsOptionInternedStr as ArchiveWith<Option<InternedStr>>>::Archived, Option<InternedStr>, __D>, AsInternedStr: ArchiveWith<InternedStr> + DeserializeWith<<AsInternedStr as ArchiveWith<InternedStr>>::Archived, InternedStr, __D>, AsVecInternedStr: ArchiveWith<Vec<InternedStr>> + DeserializeWith<<AsVecInternedStr as ArchiveWith<Vec<InternedStr>>>::Archived, Vec<InternedStr>, __D>, Metadata: Archive, <Metadata as Archive>::Archived: Deserialize<Metadata, __D>, Vec<Posting>: Archive, <Vec<Posting> as Archive>::Archived: Deserialize<Vec<Posting>, __D>,

fn deserialize( &self, deserializer: &mut __D, ) -> Result<Transaction, <__D as Fallible>::Error>

Deserializes using the given deserializer

impl Display for Transaction

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

Formats the value using the given formatter.

impl PartialEq for Transaction

fn eq(&self, other: &Transaction) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<__S: Fallible + ?Sized> Serialize<__S> for Transaction

where AsNaiveDate: SerializeWith<NaiveDate, __S>, char: Serialize<__S>, AsOptionInternedStr: SerializeWith<Option<InternedStr>, __S>, AsInternedStr: SerializeWith<InternedStr, __S>, AsVecInternedStr: SerializeWith<Vec<InternedStr>, __S>, Metadata: Serialize<__S>, Vec<Posting>: Serialize<__S>,

fn serialize( &self, serializer: &mut __S, ) -> Result<<Self as Archive>::Resolver, <__S as Fallible>::Error>

Writes the dependencies for the object and returns a resolver that can create the archived type.

impl Serialize for Transaction

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Transaction

impl StructuralPartialEq for Transaction