Struct Leverage 

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

A validated leverage value for trading positions.

Leverage represents the multiplier applied to a trader’s margin to determine the position size. This type ensures that leverage values are within acceptable bounds (1x to 100x) and can be safely used when trading futures.

Leverage values must be:

• Greater than or equal to Leverage::MIN (1x)
• Less than or equal to Leverage::MAX (100x)

Examples

use lnm_sdk::api_v3::models::Leverage;

// Create a leverage value from a float
let leverage = Leverage::try_from(10.0).unwrap();
assert_eq!(leverage.as_f64(), 10.0);

// Values outside the valid range will fail
assert!(Leverage::try_from(0.5).is_err());
assert!(Leverage::try_from(150.0).is_err());

Implementations

impl Leverage

pub const MIN: Leverage

The minimum allowed leverage value (1x).

pub const MAX: Leverage

The maximum allowed leverage value (100x).

pub fn bounded<T>(value: T) -> Leverage

where T: Into<f64>,

Creates a Leverage by bounding the given value to the valid range.

This method bounds the input to the range (Leverage::MIN, Leverage::MAX). It should be used to ensure a valid Leverage without error handling.

Note: In order to check whether a value is a valid leverage and receive an error for invalid values, use Leverage::try_from.

Examples

use lnm_sdk::api_v3::models::Leverage;

// Values within range are preserved
let l = Leverage::bounded(25.0);
assert_eq!(l.as_f64(), 25.0);

// Values below minimum are bounded to MIN
let l = Leverage::bounded(0.5);
assert_eq!(l, Leverage::MIN);

// Values above maximum are bounded to MAX
let l = Leverage::bounded(150.0);
assert_eq!(l, Leverage::MAX);

pub fn as_f64(&self) -> f64

Returns the leverage value as its underlying f64 representation.

Examples

use lnm_sdk::api_v3::models::Leverage;

let leverage = Leverage::try_from(25.0).unwrap();
assert_eq!(leverage.as_f64(), 25.0);

pub fn try_calculate( quantity: Quantity, margin: Margin, price: Price, ) -> Result<Leverage, LeverageValidationError>

Calculates leverage from quantity (USD), margin (sats), and price (BTC/USD).

The leverage is calculated using the formula:

leverage = (quantity * SATS_PER_BTC) / (margin * price)

Examples

use lnm_sdk::api_v3::models::{Leverage, Quantity, Margin, Price};

let quantity = Quantity::try_from(1_000).unwrap(); // Quantity in USD
let margin = Margin::try_from(20_000).unwrap(); // Margin in sats
let price = Price::try_from(100_000.0).unwrap(); // Price in USD/BTC

let leverage = Leverage::try_calculate(quantity, margin, price).unwrap();

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 Debug for Leverage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Leverage

fn deserialize<D>( deserializer: D, ) -> Result<Leverage, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Leverage

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

Formats the value using the given formatter.

impl From<CrossLeverage> for Leverage

fn from(value: CrossLeverage) -> Leverage

Converts to this type from the input type.

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 Serialize for Leverage

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<f32> for Leverage

type Error = LeverageValidationError

The type returned in the event of a conversion error.

fn try_from(value: f32) -> Result<Leverage, <Leverage as TryFrom<f32>>::Error>

Performs the conversion.

impl TryFrom<f64> for Leverage

type Error = LeverageValidationError

The type returned in the event of a conversion error.

fn try_from(value: f64) -> Result<Leverage, <Leverage as TryFrom<f64>>::Error>

Performs the conversion.

impl TryFrom<i16> for Leverage

type Error = LeverageValidationError

The type returned in the event of a conversion error.

fn try_from(value: i16) -> Result<Leverage, <Leverage as TryFrom<i16>>::Error>

Performs the conversion.

impl TryFrom<i32> for Leverage

type Error = LeverageValidationError

The type returned in the event of a conversion error.

fn try_from( leverage: i32, ) -> Result<Leverage, <Leverage as TryFrom<i32>>::Error>

Performs the conversion.

impl TryFrom<i64> for Leverage

type Error = LeverageValidationError

The type returned in the event of a conversion error.

fn try_from(value: i64) -> Result<Leverage, <Leverage as TryFrom<i64>>::Error>

Performs the conversion.

impl TryFrom<i8> for Leverage

type Error = LeverageValidationError

The type returned in the event of a conversion error.

fn try_from(value: i8) -> Result<Leverage, <Leverage as TryFrom<i8>>::Error>

Performs the conversion.

impl TryFrom<isize> for Leverage

type Error = LeverageValidationError

The type returned in the event of a conversion error.

fn try_from( value: isize, ) -> Result<Leverage, <Leverage as TryFrom<isize>>::Error>

Performs the conversion.

impl TryFrom<u16> for Leverage

type Error = LeverageValidationError

The type returned in the event of a conversion error.

fn try_from(value: u16) -> Result<Leverage, <Leverage as TryFrom<u16>>::Error>

Performs the conversion.

impl TryFrom<u32> for Leverage

type Error = LeverageValidationError

The type returned in the event of a conversion error.

fn try_from(value: u32) -> Result<Leverage, <Leverage as TryFrom<u32>>::Error>

Performs the conversion.

impl TryFrom<u64> for Leverage

type Error = LeverageValidationError

The type returned in the event of a conversion error.

fn try_from(value: u64) -> Result<Leverage, <Leverage as TryFrom<u64>>::Error>

Performs the conversion.

impl TryFrom<u8> for Leverage

type Error = LeverageValidationError

The type returned in the event of a conversion error.

fn try_from(value: u8) -> Result<Leverage, <Leverage as TryFrom<u8>>::Error>

Performs the conversion.

impl TryFrom<usize> for Leverage

type Error = LeverageValidationError

The type returned in the event of a conversion error.

fn try_from( value: usize, ) -> Result<Leverage, <Leverage as TryFrom<usize>>::Error>

Performs the conversion.

impl Copy for Leverage

impl Eq for Leverage

impl StructuralPartialEq for Leverage