Struct FeeParams

Source
pub struct FeeParams<T> { /* private fields */ }
Expand description

Fee Parameters.

Implementations§

Source§

impl<T> FeeParams<T>

Source

pub fn builder() -> FeeParamsBuilder<T, ((), (), (), ())>

Create a builder for building FeeParams. On the builder, call .positive_impact_fee_factor(...), .negative_impact_fee_factor(...), .fee_receiver_factor(...), .discount_factor(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of FeeParams.

Source§

impl<T> FeeParams<T>

Source

pub fn with_discount_factor(self, factor: T) -> Self

Set discount factor.

Source

pub fn receiver_factor(&self) -> &T

Get receiver factor.

Source

pub fn fee<const DECIMALS: u8>( &self, is_positive_impact: bool, amount: &T, ) -> Option<T>
where T: FixedPointOps<DECIMALS>,

Get basic fee.

Source

pub fn receiver_fee<const DECIMALS: u8>(&self, fee_amount: &T) -> Option<T>
where T: FixedPointOps<DECIMALS>,

Get receiver fee.

Source

pub fn apply_fees<const DECIMALS: u8>( &self, is_positive_impact: bool, amount: &T, ) -> Option<(T, Fees<T>)>
where T: FixedPointOps<DECIMALS>,

Apply fees to amount.

  • DECIMALS is the decimals of the parameters.

Returns None if the computation fails, otherwise amount after fees and the fees are returned.

Source

pub fn base_position_fees<const DECIMALS: u8>( &self, collateral_token_price: &Price<T>, size_delta_usd: &T, is_positive_impact: bool, ) -> Result<PositionFees<T>>
where T: FixedPointOps<DECIMALS>,

Get position fees with only order fees considered.

Trait Implementations§

Source§

impl<T: Clone> Clone for FeeParams<T>

Source§

fn clone(&self) -> FeeParams<T>

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug> Debug for FeeParams<T>

Source§

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

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

impl<T: Copy> Copy for FeeParams<T>

Auto Trait Implementations§

§

impl<T> Freeze for FeeParams<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for FeeParams<T>
where T: RefUnwindSafe,

§

impl<T> Send for FeeParams<T>
where T: Send,

§

impl<T> Sync for FeeParams<T>
where T: Sync,

§

impl<T> Unpin for FeeParams<T>
where T: Unpin,

§

impl<T> UnwindSafe for FeeParams<T>
where T: UnwindSafe,

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
Source§

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

Source§

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

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

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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