Skip to main content

MarginalIndicatorsData

Struct MarginalIndicatorsData 

Source
pub struct MarginalIndicatorsData {
    pub agreement_data: Option<AgreementData>,
    pub portfolio_current_value: Option<PortfolioCurrentValue>,
    pub portfolio_stability: Option<PortfolioStability>,
    pub forts_stability: Option<FortsStability>,
    pub margin_parameters: Option<MarginParameters>,
    pub cash_by_currency: Vec<CashByCurrency>,
    pub money_debt: Option<MoneyDebtWrapper>,
    pub margin_securities: Option<MarginSecuritiesWrapper>,
    pub futures_parameters: Option<FuturesParameters>,
}
Expand description

A margin indicators frame: the margin picture of the account in one object.

The broker docs describe nine parts. Every part is optional here. Some parts of this library do not match the docs: the docs name the fields of marginParameters marginValue, collateral, marginCall and forcedClosure, and give futuresParameters as futuresValue and a futuresPortfolio list. MarginParameters and FuturesParameters read other names, so they stay None against a broker that follows the docs. The docs list fortsMarginCall, fortsForcedClosure and riskLevel for the derivatives stability, which FortsStability does not read either. Not verified against the live API.

§Examples

use brokapi_bcs_protocol::ws::models::MarginalIndicatorsData;

let m: MarginalIndicatorsData = serde_json::from_str(
    r#"{"portfolioCurrentValue":{"currentValueRub":512000.0},"cashByCurrency":[{"currency":"RUB","sum":50000.0}]}"#,
)?;
assert_eq!(m.portfolio_current_value.unwrap().current_value_rub, Some(dec!(512000.0)));
assert_eq!(m.cash_by_currency.len(), 1);

Fields§

§agreement_data: Option<AgreementData>

Data about the account.

§portfolio_current_value: Option<PortfolioCurrentValue>

Current value of the portfolio and its changes.

§portfolio_stability: Option<PortfolioStability>

Stability (margin level) of the portfolio.

§forts_stability: Option<FortsStability>

Stability of the derivatives market account.

§margin_parameters: Option<MarginParameters>

Parameters of the margin portfolio. See the note on the type.

§cash_by_currency: Vec<CashByCurrency>

Free money by currency. Empty if the broker sent none.

§money_debt: Option<MoneyDebtWrapper>

Debts by currency.

§margin_securities: Option<MarginSecuritiesWrapper>

Margin positions.

§futures_parameters: Option<FuturesParameters>

Futures positions. See the note on the type.

Trait Implementations§

Source§

impl Clone for MarginalIndicatorsData

Source§

fn clone(&self) -> MarginalIndicatorsData

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for MarginalIndicatorsData

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for MarginalIndicatorsData

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

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

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

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

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more