Struct TimeBasedStop 

pub struct TimeBasedStop { /* private fields */ }

Time-Based Stop — exits a position purely on elapsed bars, independent of price.

bars_held increments by 1 each bar (since the last reset)
progress  = min(bars_held / max_bars, 1.0)     in [0, 1]
stop fires when progress == 1.0  (bars_held >= max_bars)

Some setups should not be given unlimited time to work: a mean-reversion entry that has not reverted within max_bars, or an event trade whose catalyst has passed, is best closed regardless of price. This indicator is a pure timer — it ignores the candle’s prices entirely and reports the fraction of the holding window that has elapsed, reaching 1.0 (the stop) after max_bars bars. Call reset on each new entry so the timer restarts from the position open.

Each update is O(1) and the first bar already emits a value (1 / max_bars).

Example

use wickra_core::{Candle, Indicator, TimeBasedStop};

let mut indicator = TimeBasedStop::new(5).unwrap();
let c = Candle::new(100.0, 101.0, 99.0, 100.0, 1.0, 0).unwrap();
// Five bars reach the stop.
let mut last = 0.0;
for _ in 0..5 {
    last = indicator.update(c).unwrap();
}
assert_eq!(last, 1.0);

Implementations

impl TimeBasedStop

pub fn new(max_bars: usize) -> Result<Self>

Construct a time-based stop that fires after max_bars bars.

Errors

Returns Error::PeriodZero if max_bars == 0.

pub const fn max_bars(&self) -> usize

Configured maximum holding period in bars.

pub const fn bars_held(&self) -> usize

Number of bars held since the last reset.

pub const fn triggered(&self) -> bool

Whether the stop has fired (the holding period has fully elapsed).

pub const fn value(&self) -> Option<f64>

Current value if available.

Trait Implementations

impl Clone for TimeBasedStop

fn clone(&self) -> TimeBasedStop

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TimeBasedStop

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

Formats the value using the given formatter.

impl Indicator for TimeBasedStop

type Input = Candle

Type of one input data point (typically f64 for a price, or Candle / Tick).

type Output = f64

Type of one output value.

fn update(&mut self, _candle: Candle) -> Option<f64>

Feed one new data point into the indicator and return the freshly computed output, or None if the indicator is still warming up.

fn reset(&mut self)

Reset all internal state, leaving the indicator equivalent to a freshly constructed instance with the same parameters.

fn warmup_period(&self) -> usize

Number of inputs required before the first non-None output can be produced.

fn is_ready(&self) -> bool

Whether the indicator has emitted at least one value since the last reset.

fn name(&self) -> &'static str

Stable, human-readable indicator name. Used by chaining and diagnostics.