Skip to main content

PositionSizer

Struct PositionSizer 

Source
pub struct PositionSizer { /* private fields */ }
Expand description

Computes order sizes from margin + leverage + price + contract multiplier.

Returns 0 if any input is non-positive or the resulting size rounds down to zero. Callers should treat 0 as “skip this trade — too small”.

§Example

use rustrade_risk::{PositionSizer, SizingConfig};

let sizer = PositionSizer::new(SizingConfig {
    margin_per_trade: 500.0,
    leverage: 5,
    max_contracts: 100,
});

// 500 USDT * 5x leverage = 2500 USDT notional.
// At price 50_000 (BTC) with contract_value 0.001 BTC:
//   contracts = floor(2500 / (50000 * 0.001)) = floor(50.0) = 50
assert_eq!(sizer.contracts(50_000.0, 0.001), 50);

// Capped at max_contracts when price is low enough to "afford" more.
assert_eq!(sizer.contracts(10.0, 0.001), 100);

// Zero on degenerate inputs.
assert_eq!(sizer.contracts(0.0, 0.001), 0);

Implementations§

Source§

impl PositionSizer

Source

pub fn new(config: SizingConfig) -> PositionSizer

Construct a sizer with the given SizingConfig.

Source

pub fn contracts(&self, price: f64, contract_value: f64) -> u32

Compute contract count for a trade.

price is the current mark or last-trade price in quote currency. contract_value is the base-asset units per 1 contract (e.g. 0.001 for XBTUSDTM).

Source

pub fn contracts_with_margin( &self, margin_usd: f64, price: f64, contract_value: f64, ) -> u32

Same as Self::contracts but takes an explicit override for the per-trade margin (used by brains that want to scale up/down based on confidence or by the framework when honouring SizeHint::NotionalUsd).

Source

pub fn config(&self) -> &SizingConfig

Borrow the sizer’s underlying config.

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

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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