Struct AccountRef 

pub struct AccountRef<'a>(/* private fields */);

Lifetime-scoped read borrow of a cached account.

Returned by crate::cache::Cache::account. The borrow drops with the enclosing scope, which makes any attempt to hold it across a cache mutation panic at runtime: a loud failure beats the silent staleness that a stored clone would produce.

Method calls on the inner AccountAny resolve via Deref; comparisons against &AccountAny or owned AccountAny values are direct (account_ref == &account); Debug forwards to the inner record. Use cloned when an owned snapshot is required (for example, before crossing a boundary that may dispatch events).

Implementations

impl<'a> AccountRef<'a>

pub fn new(inner: Ref<'a, AccountAny>) -> Self

Wraps the given Ref borrow.

pub fn cloned(&self) -> AccountAny

Returns an owned snapshot of the borrowed account.

Mirrors Option::cloned and Iterator::cloned; the snapshot will not reflect later mutations of the underlying cell.

Methods from Deref<Target = AccountAny>

pub fn id(&self) -> AccountId

pub fn last_event(&self) -> Option<AccountState>

pub fn events(&self) -> Vec<AccountState>

pub fn balances(&self) -> IndexMap<Currency, AccountBalance>

pub fn balances_locked(&self) -> IndexMap<Currency, Money>

pub fn base_currency(&self) -> Option<Currency>

pub fn calculate_pnls( &self, instrument: &InstrumentAny, fill: &OrderFilled, position: Option<Position>, ) -> Result<Vec<Money>, Error>

Errors

Returns an error if calculating P&Ls fails for the underlying account.

pub fn calculate_commission( &self, instrument: &InstrumentAny, last_qty: Quantity, last_px: Price, liquidity_side: LiquiditySide, use_quote_for_inverse: Option<bool>, ) -> Result<Money, Error>

Errors

Returns an error if calculating commission fails for the underlying account.

pub fn balance(&self, currency: Option<Currency>) -> Option<&AccountBalance>

Trait Implementations

impl AsRef<AccountAny> for AccountRef<'_>

fn as_ref(&self) -> &AccountAny

Converts this type into a shared reference of the (usually inferred) input type.

impl Debug for AccountRef<'_>

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

Formats the value using the given formatter.

impl Deref for AccountRef<'_>

type Target = AccountAny

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a> From<Ref<'a, AccountAny>> for AccountRef<'a>

fn from(inner: Ref<'a, AccountAny>) -> Self

Converts to this type from the input type.

impl PartialEq<&AccountAny> for AccountRef<'_>

fn eq(&self, other: &&AccountAny) -> 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 PartialEq<AccountAny> for AccountRef<'_>

fn eq(&self, other: &AccountAny) -> 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.