Struct Split 

pub struct Split { /* private fields */ }

A GnuCash Split - a single entry in a transaction.

A Split represents one side of a double-entry transaction, linking an amount to an account. Each Split has both an ‘amount’ (in the account’s commodity) and a ‘value’ (in the transaction’s currency).

Implementations

impl Split

pub fn new(book: &Book) -> Self

Creates a new Split in the given book.

pub unsafe fn from_raw(ptr: *mut Split, owned: bool) -> Option<Self>

Creates a Split wrapper from a raw pointer.

Safety

The pointer must be valid and point to a properly initialized Split.

pub fn as_ptr(&self) -> *mut Split

Returns the raw pointer to the underlying Split.

pub fn guid(&self) -> Guid

Returns the GUID of this split.

pub fn reinit(&self)

Reinitializes the split to default values.

pub fn account(&self) -> Option<Account>

Returns the account this split belongs to.

pub fn set_account(&self, account: &Account)

Sets the account for this split.

pub fn transaction(&self) -> Option<Transaction>

Returns the parent transaction of this split.

pub fn set_transaction(&self, trans: &Transaction)

Sets the parent transaction for this split.

pub fn book(&self) -> Option<Book>

Returns the book this split belongs to.

pub fn memo(&self) -> Option<String>

Returns the split memo.

pub fn set_memo(&self, memo: &str)

Sets the split memo.

Panics

Panics if memo contains a null byte.

pub fn action(&self) -> Option<String>

Returns the split action (e.g., “Buy”, “Sell”, “Deposit”).

pub fn set_action(&self, action: &str)

Sets the split action.

Panics

Panics if action contains a null byte.

pub fn split_type(&self) -> Option<String>

Returns the split type (“normal” or “stock-split”).

pub fn make_stock_split(&self)

Marks this split as a stock split.

pub fn amount(&self) -> Numeric

Returns the amount in the account’s commodity.

pub fn set_amount(&self, amount: Numeric)

Sets the amount in the account’s commodity.

pub fn value(&self) -> Numeric

Returns the value in the transaction’s currency.

pub fn set_value(&self, value: Numeric)

Sets the value in the transaction’s currency.

pub fn share_price(&self) -> Numeric

Returns the share price (value / amount).

pub fn set_share_price_and_amount(&self, price: Numeric, amount: Numeric)

Sets both share price and amount simultaneously.

pub fn balance(&self) -> Numeric

Returns the running balance up to and including this split.

pub fn noclosing_balance(&self) -> Numeric

Returns the running balance excluding closing transactions.

pub fn cleared_balance(&self) -> Numeric

Returns the cleared balance (cleared + reconciled splits).

pub fn reconciled_balance(&self) -> Numeric

Returns the reconciled balance (only reconciled splits).

pub fn reconcile_state(&self) -> char

Returns the reconcile state (‘n’, ‘c’, ‘y’, ‘f’, ‘v’).

pub fn set_reconcile_state(&self, state: char)

Sets the reconcile state.

pub fn date_reconciled(&self) -> i64

Returns the date when this split was reconciled.

pub fn set_date_reconciled(&self, time: i64)

Sets the date when this split was reconciled.

pub fn is_reconciled(&self) -> bool

Returns true if this split is reconciled.

pub fn is_cleared(&self) -> bool

Returns true if this split is cleared.

pub fn other_split(&self) -> Option<Split>

Returns the other split in a two-split transaction. Returns None if the transaction has more than two splits.

pub fn corr_account_full_name(&self) -> Option<String>

Returns the full name of the corresponding account.

pub fn corr_account_name(&self) -> Option<String>

Returns the name of the corresponding account.

pub fn corr_account_code(&self) -> Option<String>

Returns the code of the corresponding account.

pub fn void_former_amount(&self) -> Numeric

Returns the original amount before voiding.

pub fn void_former_value(&self) -> Numeric

Returns the original value before voiding.

pub fn has_peers(&self) -> bool

Returns true if this split has peer splits.

pub fn is_peer(&self, other: &Split) -> bool

Returns true if the other split is a peer of this one.

pub fn add_peer(&self, other: &Split, timestamp: i64)

Adds a peer split to this split’s lot-split list.

pub fn remove_peer(&self, other: &Split)

Removes a peer split from this split’s lot-split list.

Trait Implementations

impl Debug for Split

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

Formats the value using the given formatter.

impl Drop for Split

fn drop(&mut self)

Executes the destructor for this type.

impl Hash for Split

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 Split

fn eq(&self, other: &Self) -> 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 Eq for Split

impl Send for Split