Struct AccountRefMut 

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

Lifetime-scoped exclusive write borrow of a cached account.

Returned by crate::cache::Cache::account_mut. While the borrow is alive, no other read or write on the same cell is permitted (enforced at runtime by the underlying RefMut). Drop the borrow before dispatching events or taking any other cache borrow that may re-enter the same account.

Implementations

impl<'a> AccountRefMut<'a>

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

Wraps the given RefMut borrow.

pub fn cloned(&self) -> AccountAny

Returns an owned snapshot of the borrowed account.

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 apply(&mut self, event: AccountState) -> Result<(), Error>

Applies an account state event to update the account.

Errors

Returns an error if the account state cannot be applied (e.g., negative balance when borrowing is not allowed for a cash account).

pub fn set_calculate_account_state(&mut self, calculate_account_state: bool)

Sets whether account state should be recalculated from order fills.

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 AsMut<AccountAny> for AccountRefMut<'_>

fn as_mut(&mut self) -> &mut AccountAny

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

impl AsRef<AccountAny> for AccountRefMut<'_>

fn as_ref(&self) -> &AccountAny

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

impl Debug for AccountRefMut<'_>

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

Formats the value using the given formatter.

impl Deref for AccountRefMut<'_>

type Target = AccountAny

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for AccountRefMut<'_>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'a> From<RefMut<'a, AccountAny>> for AccountRefMut<'a>

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

Converts to this type from the input type.

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

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 AccountRefMut<'_>

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.