gmsol::types::market::revertible

Struct RevertiblePosition

Source 
pub struct RevertiblePosition<'a, 'info> { /* private fields */ }
Expand description

Revertible Position.

Trait Implementations§

Source§

impl<'a, 'info> Position<gmsol_store::::states::market::revertible::revertible_position::{impl#3}::{constant#0}> for RevertiblePosition<'a, 'info>

Source§

type Market = RevertibleMarket<'a, 'info>

Market type.
Source§

fn market( &self, ) -> &<RevertiblePosition<'a, 'info> as Position<gmsol_store::::states::market::revertible::revertible_position::{impl#3}::{constant#0}>>::Market

Get a reference to the market.
Source§

fn is_long(&self) -> bool

Returns whether the position is a long position.
Source§

fn is_collateral_token_long(&self) -> bool

Returns whether the collateral token is the long token of the market.
Source§

fn are_pnl_and_collateral_tokens_the_same(&self) -> bool

Returns whether the pnl and collateral tokens are the same.
Source§

fn on_validate(&self) -> Result<(), Error>

Called from validate_position to add supplementary checks.
Source§

impl PositionMut<gmsol_store::::states::market::revertible::revertible_position::{impl#4}::{constant#0}> for RevertiblePosition<'_, '_>

Source§

fn market_mut( &mut self, ) -> &mut <RevertiblePosition<'_, '_> as Position<gmsol_store::::states::market::revertible::revertible_position::{impl#4}::{constant#0}>>::Market

Get a mutable reference to the market.
Source§

fn on_increased(&mut self) -> Result<(), Error>

Increased callback.
Source§

fn on_decreased(&mut self) -> Result<(), Error>

Decreased callback.
Source§

fn on_swapped( &mut self, ty: DecreasePositionSwapType, report: &SwapReport<<RevertiblePosition<'_, '_> as PositionState<gmsol_store::::states::market::revertible::revertible_position::{impl#4}::{constant#0}>>::Num, <<RevertiblePosition<'_, '_> as PositionState<gmsol_store::::states::market::revertible::revertible_position::{impl#4}::{constant#0}>>::Num as Unsigned>::Signed>, ) -> Result<(), Error>

Swapped callback.
Source§

fn on_swap_error( &mut self, ty: DecreasePositionSwapType, error: Error, ) -> Result<(), Error>

Handle swap error.
Source§

impl PositionState<gmsol_store::::states::market::revertible::revertible_position::{impl#2}::{constant#0}> for RevertiblePosition<'_, '_>

Source§

type Num = u128

Unsigned number type.
Source§

type Signed = i128

Signed number type.
Source§

fn collateral_amount( &self, ) -> &<RevertiblePosition<'_, '_> as PositionState<gmsol_store::::states::market::revertible::revertible_position::{impl#2}::{constant#0}>>::Num

Get the collateral amount.
Source§

fn size_in_usd( &self, ) -> &<RevertiblePosition<'_, '_> as PositionState<gmsol_store::::states::market::revertible::revertible_position::{impl#2}::{constant#0}>>::Num

Get a reference to the size (in USD) of the position.
Source§

fn size_in_tokens( &self, ) -> &<RevertiblePosition<'_, '_> as PositionState<gmsol_store::::states::market::revertible::revertible_position::{impl#2}::{constant#0}>>::Num

Get a reference to the size (in tokens) of the position.
Source§

fn borrowing_factor( &self, ) -> &<RevertiblePosition<'_, '_> as PositionState<gmsol_store::::states::market::revertible::revertible_position::{impl#2}::{constant#0}>>::Num

Get a reference to last borrowing factor applied by the position.
Source§

fn funding_fee_amount_per_size( &self, ) -> &<RevertiblePosition<'_, '_> as PositionState<gmsol_store::::states::market::revertible::revertible_position::{impl#2}::{constant#0}>>::Num

Get a reference to the funding fee amount per size.
Source§

fn claimable_funding_fee_amount_per_size( &self, is_long_collateral: bool, ) -> &<RevertiblePosition<'_, '_> as PositionState<gmsol_store::::states::market::revertible::revertible_position::{impl#2}::{constant#0}>>::Num

Get a reference to claimable funding fee amount per size of the given collateral.
Source§

impl PositionStateMut<gmsol_store::::states::market::revertible::revertible_position::{impl#5}::{constant#0}> for RevertiblePosition<'_, '_>

Source§

fn collateral_amount_mut( &mut self, ) -> &mut <RevertiblePosition<'_, '_> as PositionState<gmsol_store::::states::market::revertible::revertible_position::{impl#5}::{constant#0}>>::Num

Get a mutable reference to the collateral amount.
Source§

fn size_in_usd_mut( &mut self, ) -> &mut <RevertiblePosition<'_, '_> as PositionState<gmsol_store::::states::market::revertible::revertible_position::{impl#5}::{constant#0}>>::Num

Get a mutable reference to the size (in USD) of the position.
Source§

fn size_in_tokens_mut( &mut self, ) -> &mut <RevertiblePosition<'_, '_> as PositionState<gmsol_store::::states::market::revertible::revertible_position::{impl#5}::{constant#0}>>::Num

Get a mutable reference to the size (in tokens) of the position.
Source§

fn borrowing_factor_mut( &mut self, ) -> &mut <RevertiblePosition<'_, '_> as PositionState<gmsol_store::::states::market::revertible::revertible_position::{impl#5}::{constant#0}>>::Num

Get a mutable reference to last borrowing factor applied by the position.
Source§

fn funding_fee_amount_per_size_mut( &mut self, ) -> &mut <RevertiblePosition<'_, '_> as PositionState<gmsol_store::::states::market::revertible::revertible_position::{impl#5}::{constant#0}>>::Num

Get a mutable reference to the funding fee amount per size.
Source§

fn claimable_funding_fee_amount_per_size_mut( &mut self, is_long_collateral: bool, ) -> &mut <RevertiblePosition<'_, '_> as PositionState<gmsol_store::::states::market::revertible::revertible_position::{impl#5}::{constant#0}>>::Num

Get a mutable reference to claimable funding fee amount per size of the given collateral.
Source§

impl Revertible for RevertiblePosition<'_, '_>

Source§

fn commit(self)

Commit the changes. Read more

Auto Trait Implementations§

§

impl<'a, 'info> Freeze for RevertiblePosition<'a, 'info>

§

impl<'a, 'info> !RefUnwindSafe for RevertiblePosition<'a, 'info>

§

impl<'a, 'info> !Send for RevertiblePosition<'a, 'info>

§

impl<'a, 'info> !Sync for RevertiblePosition<'a, 'info>

§

impl<'a, 'info> Unpin for RevertiblePosition<'a, 'info>

§

impl<'a, 'info> !UnwindSafe for RevertiblePosition<'a, 'info>

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
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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
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.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<const DECIMALS: u8, P> PositionExt<DECIMALS> for P
where P: Position<DECIMALS>,

Source§

fn will_collateral_be_sufficient( &self, prices: &Prices<Self::Num>, delta: &CollateralDelta<Self::Num>, ) -> Result<WillCollateralBeSufficient<Self::Signed>, Error>

Check that whether the collateral will be sufficient after paying the given realized_pnl and applying delta_size. Read more
Source§

fn collateral_price<'a>( &self, prices: &'a Prices<Self::Num>, ) -> &'a Price<Self::Num>

Get collateral price.
Source§

fn collateral_value( &self, prices: &Prices<Self::Num>, ) -> Result<Self::Num, Error>

Get collateral value.
Source§

fn pnl_value( &self, prices: &Prices<Self::Num>, size_delta_usd: &Self::Num, ) -> Result<(Self::Signed, Self::Signed, Self::Num), Error>

Calculate the pnl value when decreased by the given delta size. Read more
Source§

fn validate( &self, prices: &Prices<Self::Num>, should_validate_min_position_size: bool, should_validate_min_collateral_usd: bool, ) -> Result<(), Error>

Validate the position.
Source§

fn check_liquidatable( &self, prices: &Prices<Self::Num>, should_validate_min_collateral_usd: bool, ) -> Result<Option<LiquidatableReason>, Error>

Check if the position is liquidatable. Read more
Source§

fn position_price_impact( &self, size_delta_usd: &Self::Signed, ) -> Result<Self::Signed, Error>

Get position price impact.
Source§

fn capped_positive_position_price_impact( &self, index_token_price: &Price<Self::Num>, size_delta_usd: &Self::Signed, ) -> Result<Self::Signed, Error>

Get position price impact usd and cap the value if it is positive.
Source§

fn capped_position_price_impact( &self, index_token_price: &Price<Self::Num>, size_delta_usd: &Self::Signed, ) -> Result<(Self::Signed, Self::Num), Error>

Get capped position price impact usd. Read more
Source§

fn pending_borrowing_fee_value(&self) -> Result<Self::Num, Error>

Get pending borrowing fee value of this position.
Source§

fn pending_funding_fees(&self) -> Result<FundingFees<Self::Num>, Error>

Get pending funding fees.
Source§

fn position_fees( &self, collateral_token_price: &Price<Self::Num>, size_delta_usd: &Self::Num, is_positive_impact: bool, is_liquidation: bool, ) -> Result<PositionFees<Self::Num>, Error>

Calculates the PositionFees generated by changing the position size by the specified size_delta_usd.
Source§

impl<const DECIMALS: u8, P> PositionStateExt<DECIMALS> for P
where P: PositionState<DECIMALS> + ?Sized,

Source§

fn is_empty(&self) -> bool

Return whether the position is considered to be empty during the decrease position action.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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
§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeSendSync for T