Skip to main content

StrategyBuilder

Struct StrategyBuilder 

Source
pub struct StrategyBuilder<E = (), X = ()> { /* private fields */ }
Expand description

Builder for creating custom strategies with entry/exit conditions.

The builder enforces that both entry and exit conditions are provided before a strategy can be built.

An optional regime filter can be set at any point in the chain via .regime_filter(). When set, the filter is evaluated on every bar; if it returns false, all entry signals are suppressed. Exit signals are never blocked by the regime filter.

Implementations§

Source§

impl StrategyBuilder<(), ()>

Source

pub fn new(name: impl Into<String>) -> Self

Create a new strategy builder with a name.

§Example
let builder = StrategyBuilder::new("My Strategy");
Source§

impl<X> StrategyBuilder<(), X>

Source

pub fn entry<C: Condition>(self, condition: C) -> StrategyBuilder<C, X>

Set the entry condition for long positions.

§Example
let builder = StrategyBuilder::new("RSI Strategy")
    .entry(rsi(14).crosses_below(30.0));
Source§

impl<E> StrategyBuilder<E, ()>

Source

pub fn exit<C: Condition>(self, condition: C) -> StrategyBuilder<E, C>

Set the exit condition for long positions.

§Example
let builder = StrategyBuilder::new("RSI Strategy")
    .entry(rsi(14).crosses_below(30.0))
    .exit(rsi(14).crosses_above(70.0));
Source§

impl<E, X> StrategyBuilder<E, X>

Source

pub fn regime_filter<C: Condition>(self, condition: C) -> Self

Set a market regime filter.

When set, entry signals (long and short) are suppressed on any bar where the filter evaluates to false. Exit signals are never blocked by the regime filter, ensuring open positions can always be closed regardless of market conditions.

The regime filter’s indicators are included in required_indicators() and therefore pre-computed by the engine like any other indicator.

§Example
use finance_query::backtesting::strategy::StrategyBuilder;
use finance_query::backtesting::refs::*;

// Only trade when price is above the 200-period SMA
let strategy = StrategyBuilder::new("Trend Following")
    .regime_filter(sma(200).above_ref(sma(400)))
    .entry(ema(10).crosses_above_ref(ema(30)))
    .exit(ema(10).crosses_below_ref(ema(30)))
    .build();
Source§

impl<E: Condition, X: Condition> StrategyBuilder<E, X>

Source

pub fn with_short<SE: Condition, SX: Condition>( self, entry: SE, exit: SX, ) -> Self

Enable short positions with entry and exit conditions.

§Example
let strategy = StrategyBuilder::new("RSI Strategy")
    .entry(rsi(14).crosses_below(30.0))
    .exit(rsi(14).crosses_above(70.0))
    .with_short(
        rsi(14).crosses_above(70.0),  // Short entry
        rsi(14).crosses_below(30.0),  // Short exit
    )
    .build();
Source

pub fn warmup(self, bars: usize) -> Self

Override the automatic warmup period with an explicit bar count.

By default the warmup period is inferred from each indicator’s Indicator::warmup_bars() method. Use this override when the automatic value doesn’t match your specific needs.

§Example
let strategy = StrategyBuilder::new("MACD + RSI")
    .entry(macd(12, 26, 9).crosses_above_zero())
    .exit(rsi(14).crosses_above(70.0))
    .warmup(36) // explicit override
    .build();
Source

pub fn build(self) -> CustomStrategy<E, X>

Build the strategy.

§Example
let strategy = StrategyBuilder::new("My Strategy")
    .entry(rsi(14).crosses_below(30.0))
    .exit(rsi(14).crosses_above(70.0))
    .build();

Auto Trait Implementations§

§

impl<E, X> Freeze for StrategyBuilder<E, X>
where E: Freeze, X: Freeze,

§

impl<E = (), X = ()> !RefUnwindSafe for StrategyBuilder<E, X>

§

impl<E, X> Send for StrategyBuilder<E, X>
where E: Send, X: Send,

§

impl<E, X> Sync for StrategyBuilder<E, X>
where E: Sync, X: Sync,

§

impl<E, X> Unpin for StrategyBuilder<E, X>
where E: Unpin, X: Unpin,

§

impl<E, X> UnsafeUnpin for StrategyBuilder<E, X>
where E: UnsafeUnpin, X: UnsafeUnpin,

§

impl<E = (), X = ()> !UnwindSafe for StrategyBuilder<E, X>

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> 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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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

impl<T> PlanCallbackArgs for T

Source§

impl<T> PlanCallbackOut for T