[][src]Struct fxoanda_definitions::CalculatedAccountState

pub struct CalculatedAccountState {
    pub margin_closeout_nav: Option<f32>,
    pub margin_used: Option<f32>,
    pub margin_available: Option<f32>,
    pub withdrawal_limit: Option<f32>,
    pub unrealized_pl: Option<f32>,
    pub margin_closeout_margin_used: Option<f32>,
    pub margin_call_margin_used: Option<f32>,
    pub margin_call_percent: Option<f32>,
    pub margin_closeout_percent: Option<f32>,
    pub nav: Option<f32>,
    pub margin_closeout_unrealized_pl: Option<f32>,
    pub margin_closeout_position_value: Option<f32>,
    pub position_value: Option<f32>,
}

Fields

margin_closeout_nav: Option<f32>

The Account's margin closeout NAV. format: A decimal number encoded as a string. The amount of precision provided depends on the Account's home currency.

margin_used: Option<f32>

Margin currently used for the Account. format: A decimal number encoded as a string. The amount of precision provided depends on the Account's home currency.

margin_available: Option<f32>

Margin available for Account currency. format: A decimal number encoded as a string. The amount of precision provided depends on the Account's home currency.

withdrawal_limit: Option<f32>

The current WithdrawalLimit for the account which will be zero or a positive value indicating how much can be withdrawn from the account. format: A decimal number encoded as a string. The amount of precision provided depends on the Account's home currency.

unrealized_pl: Option<f32>

The total unrealized profit/loss for all Trades currently open in the Account. format: A decimal number encoded as a string. The amount of precision provided depends on the Account's home currency.

margin_closeout_margin_used: Option<f32>

The Account's margin closeout margin used. format: A decimal number encoded as a string. The amount of precision provided depends on the Account's home currency.

margin_call_margin_used: Option<f32>

The Account's margin call margin used. format: A decimal number encoded as a string. The amount of precision provided depends on the Account's home currency.

margin_call_percent: Option<f32>

The Account's margin call percentage. When this value is 1.0 or above the Account is in a margin call situation. format: A decimal number encoded as a string. The amount of precision provided depends on what the number represents.

margin_closeout_percent: Option<f32>

The Account's margin closeout percentage. When this value is 1.0 or above the Account is in a margin closeout situation. format: A decimal number encoded as a string. The amount of precision provided depends on what the number represents.

nav: Option<f32>

The net asset value of the Account. Equal to Account balance + unrealizedPL. format: A decimal number encoded as a string. The amount of precision provided depends on the Account's home currency.

margin_closeout_unrealized_pl: Option<f32>

The Account's margin closeout unrealized PL. format: A decimal number encoded as a string. The amount of precision provided depends on the Account's home currency.

margin_closeout_position_value: Option<f32>

The value of the Account's open positions as used for margin closeout calculations represented in the Account's home currency. format: A decimal number encoded as a string. The amount of precision provided depends on what the number represents.

position_value: Option<f32>

The value of the Account's open positions represented in the Account's home currency. format: A decimal number encoded as a string. The amount of precision provided depends on the Account's home currency.

Methods

impl CalculatedAccountState[src]

pub fn new() -> CalculatedAccountState[src]

pub fn with_margin_closeout_nav(self, x: f32) -> Self[src]

The Account's margin closeout NAV. format: A decimal number encoded as a string. The amount of precision provided depends on the Account's home currency.

  • param f32
  • return CalculatedAccountState

pub fn with_margin_used(self, x: f32) -> Self[src]

Margin currently used for the Account. format: A decimal number encoded as a string. The amount of precision provided depends on the Account's home currency.

  • param f32
  • return CalculatedAccountState

pub fn with_margin_available(self, x: f32) -> Self[src]

Margin available for Account currency. format: A decimal number encoded as a string. The amount of precision provided depends on the Account's home currency.

  • param f32
  • return CalculatedAccountState

pub fn with_withdrawal_limit(self, x: f32) -> Self[src]

The current WithdrawalLimit for the account which will be zero or a positive value indicating how much can be withdrawn from the account. format: A decimal number encoded as a string. The amount of precision provided depends on the Account's home currency.

  • param f32
  • return CalculatedAccountState

pub fn with_unrealized_pl(self, x: f32) -> Self[src]

The total unrealized profit/loss for all Trades currently open in the Account. format: A decimal number encoded as a string. The amount of precision provided depends on the Account's home currency.

  • param f32
  • return CalculatedAccountState

pub fn with_margin_closeout_margin_used(self, x: f32) -> Self[src]

The Account's margin closeout margin used. format: A decimal number encoded as a string. The amount of precision provided depends on the Account's home currency.

  • param f32
  • return CalculatedAccountState

pub fn with_margin_call_margin_used(self, x: f32) -> Self[src]

The Account's margin call margin used. format: A decimal number encoded as a string. The amount of precision provided depends on the Account's home currency.

  • param f32
  • return CalculatedAccountState

pub fn with_margin_call_percent(self, x: f32) -> Self[src]

The Account's margin call percentage. When this value is 1.0 or above the Account is in a margin call situation. format: A decimal number encoded as a string. The amount of precision provided depends on what the number represents.

  • param f32
  • return CalculatedAccountState

pub fn with_margin_closeout_percent(self, x: f32) -> Self[src]

The Account's margin closeout percentage. When this value is 1.0 or above the Account is in a margin closeout situation. format: A decimal number encoded as a string. The amount of precision provided depends on what the number represents.

  • param f32
  • return CalculatedAccountState

pub fn with_nav(self, x: f32) -> Self[src]

The net asset value of the Account. Equal to Account balance + unrealizedPL. format: A decimal number encoded as a string. The amount of precision provided depends on the Account's home currency.

  • param f32
  • return CalculatedAccountState

pub fn with_margin_closeout_unrealized_pl(self, x: f32) -> Self[src]

The Account's margin closeout unrealized PL. format: A decimal number encoded as a string. The amount of precision provided depends on the Account's home currency.

  • param f32
  • return CalculatedAccountState

pub fn with_margin_closeout_position_value(self, x: f32) -> Self[src]

The value of the Account's open positions as used for margin closeout calculations represented in the Account's home currency. format: A decimal number encoded as a string. The amount of precision provided depends on what the number represents.

  • param f32
  • return CalculatedAccountState

pub fn with_position_value(self, x: f32) -> Self[src]

The value of the Account's open positions represented in the Account's home currency. format: A decimal number encoded as a string. The amount of precision provided depends on the Account's home currency.

  • param f32
  • return CalculatedAccountState

Trait Implementations

impl Debug for CalculatedAccountState[src]

impl Serialize for CalculatedAccountState[src]

impl<'de> Deserialize<'de> for CalculatedAccountState[src]

Auto Trait Implementations

Blanket Implementations

impl<T> From for T[src]

impl<T, U> Into for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom for T where
    U: Into<T>, 
[src]

type Error = !

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> BorrowMut for T where
    T: ?Sized
[src]

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

impl<T> DeserializeOwned for T where
    T: Deserialize<'de>, 
[src]