Struct Transaction 

pub struct Transaction(/* private fields */);

DATE FLAG ["PAYEE"] "NARRATION" #TAG... ^LINK... followed by indented POSTING lines and META_ENTRY sub-lines.

Implementations

impl Transaction

pub fn date(&self) -> Option<Date>

pub fn flag(&self) -> Option<TransactionFlag>

Transaction flag token. May be STAR (*), PENDING_KW (!), FLAG letter, HASH (#), TXN_KW (the txn keyword), single-char CURRENCY (ticker-letter flag), or absent (implied via a leading STRING payee/narration).

Scoped to the flag-position region (between DATE and the first STRING/TAG/LINK) so a stray trailing single-char CURRENCY after the narration is NOT misclassified as a flag.

pub fn strings(&self) -> impl Iterator<Item = StringLit> + '_

All STRING tokens in the header, in source order.

Scoped to the header (tokens before the terminating NEWLINE), so STRING tokens emitted into TRANSACTION by emit_transaction_body’s catch-all for malformed indented body lines are excluded.

The 2-string convention ("payee" "narration") is the canonical form; Self::payee and Self::narration follow it strictly. For 3+ strings (malformed but losslessly parsed), use this method to surface every header string.

pub fn payee(&self) -> Option<StringLit>

The payee string, if a separate payee + narration pair is present. Returns Some(first) ONLY when exactly two header STRING tokens appear (the canonical "payee" "narration" shape). With 0, 1, or 3+ strings the convention is ambiguous and this returns None — use Self::strings for lossless access.

pub fn narration(&self) -> Option<StringLit>

The narration string. Returns Some(only) for a single header string and Some(last) for the 2-string "payee" "narration" form. Returns None for 0 or 3+ strings — use Self::strings for lossless access on malformed headers.

pub fn tags(&self) -> impl Iterator<Item = Tag> + '_

All #TAG tokens attached to the transaction header. Scoped to the header region (excludes body tokens).

pub fn links(&self) -> impl Iterator<Item = Link> + '_

All ^LINK tokens attached to the transaction header. Scoped to the header region (excludes body tokens).

pub fn postings(&self) -> impl Iterator<Item = Posting> + '_

All POSTING sub-lines, in source order.

pub fn meta_entries(&self) -> impl Iterator<Item = MetaEntry> + '_

Transaction-level META_ENTRY sub-lines — those not attached to a posting (chiefly metadata preceding the first posting).

Trait Implementations

impl AstNode for Transaction

fn can_cast(kind: SyntaxKind) -> bool

Returns true iff kind is the wrapper’s expected node kind. Used by cast and by enum dispatch.

fn cast(syntax: SyntaxNode) -> Option<Self>

Wrap syntax if its kind matches; otherwise None.

fn syntax(&self) -> &SyntaxNode

The underlying CST node. text() reproduces the original bytes; children() / children_with_tokens() walk the tree.

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 Eq for Transaction

impl Hash for Transaction

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

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 StructuralPartialEq for Transaction