Struct Leverage 

pub struct Leverage(/* private fields */);

Leverage multiplier used to calculate required margin.

Stored internally as fixed-point with scale 10.

Implementations

impl Leverage

pub const SCALE: u16 = 10

Fixed-point scale for internal leverage storage.

pub const MIN: u16 = 1

Minimum valid leverage in whole units (1x).

pub const MAX: u16 = 3000

Maximum valid leverage in whole units (3000x).

pub const STEP: f32 = 0.1

Supported leverage step.

pub fn from_raw(raw: u16) -> Result<Self, Error>

Creates leverage from fixed-point raw value with scale Self::SCALE.

For example:

• 10 means 1.0x
• 11 means 1.1x
• 1005 means 100.5x

Errors

Returns Error::InvalidLeverage when raw is outside 10..=30000.

pub const fn raw(&self) -> u16

Returns fixed-point raw value with scale Self::SCALE.

pub fn from_u16(multiplier: u16) -> Result<Self, Error>

Creates leverage from an integer multiplier.

Examples

use openpit::param::Leverage;

let lev = Leverage::from_u16(100)?;
assert_eq!(lev.value(), 100.0);

Errors

Returns Error::InvalidLeverage when multiplier is outside 1..=3000.

pub fn from_f64(multiplier: f64) -> Result<Self, Error>

Creates leverage from floating-point multiplier.

Value must be finite, in range 1.0..=3000.0, and aligned to step 0.1.

Examples

use openpit::param::Leverage;

let lev = Leverage::from_f64(100.5)?;
assert_eq!(lev.value(), 100.5);

Errors

Returns Error::InvalidLeverage when multiplier is not finite, outside 1.0..=3000.0, or not aligned to 0.1 step.

pub fn value(&self) -> f32

Returns the leverage value as floating-point multiplier.

Examples

use openpit::param::Leverage;

let lev = Leverage::from_f64(123.4)?;
assert_eq!(lev.value(), 123.4);

pub fn calculate_margin_required( &self, notional: Notional, ) -> Result<Notional, Error>

Computes the margin required to hold notional at this leverage.

Formula: margin = notional / leverage.

Uses exact decimal arithmetic.

Examples

use openpit::param::{Leverage, Notional};

let lev = Leverage::from_u16(100)?;
let notional = Notional::from_str("10000")?;
let margin = lev.calculate_margin_required(notional)?;
assert_eq!(margin.to_string(), "100");

Errors

Returns Error::Overflow with ParamKind::Notional on arithmetic overflow.

Trait Implementations

impl Clone for Leverage

fn clone(&self) -> Leverage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Leverage

impl Debug for Leverage

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

Formats the value using the given formatter.

impl Display for Leverage

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

Formats the value using the given formatter.

impl Eq for Leverage

impl Hash for Leverage

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Leverage

fn cmp(&self, other: &Leverage) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Leverage

fn eq(&self, other: &Leverage) -> 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 PartialOrd for Leverage

fn partial_cmp(&self, other: &Leverage) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Leverage