Struct IndicatorFactory 

pub struct IndicatorFactory { /* private fields */ }

A factory that creates Indicator instances by name.

On construction, catalogue studies are registered under their canonical Indicator::name (e.g. "SMA", "RSI", "MACD", "SuperTrend") using its conventional default parameters. Each name selects a distinct calculation or source range. Additional indicators can be registered at runtime with register.

create and has also resolve the names of seven exported studies the catalogue leaves out, so that a template, a copied study or a saved layout of one is recreated: CVD, C2C Vol, HL2, HLC3, Price Channel, Ehlers Fisher and MA Combination, which creates MACombination::ribbon for its inputs to reshape. They have no category and are not in list or count.

Implementations

impl IndicatorFactory

pub const CUSTOM: &'static str = "Custom"

The category of every indicator added with register.

pub const PERSONAL: &'static str = "Personal"

The category of the user’s own studies, such as scripts the host compiles or imports; a study browser lists them as the user’s scripts.

pub const COMMUNITY: &'static str = "Community"

The category of studies the host obtains from other users.

pub const PROFILES: &'static str = "Profiles"

The category of the built-in volume and time price profiles.

pub const PATTERNS: &'static str = "Patterns"

The category of the built-in pattern detectors.

pub const ORDER_FLOW: &'static str = "Order flow"

The category of studies computed from trades, quotes or the order book.

pub fn new() -> Self

Create a factory with the built-in catalogue enabled by the current features.

pub fn register<F>(&mut self, name: impl Into<String>, constructor: F) -> bool

where F: Fn() -> Box<dyn Indicator> + Send + Sync + 'static,

Register a named indicator constructor in the CUSTOM category.

A constructor already registered under name, a built-in included, is replaced. Returns false, registering nothing, when name is empty or only whitespace.

Arguments

• name – The lookup key (e.g. "MySMA").
• constructor – A closure that returns a new boxed indicator.

pub fn register_in<F>( &mut self, category: &'static str, name: impl Into<String>, constructor: F, ) -> bool

where F: Fn() -> Box<dyn Indicator> + Send + Sync + 'static,

Register a named indicator constructor in category, such as PERSONAL for a script the user imported, COMMUNITY or PROFILES or ORDER_FLOW.

A constructor already registered under name, a built-in included, is replaced. Returns false, registering nothing, when name is empty or only whitespace.

pub fn create(&self, name: &str) -> Option<Box<dyn Indicator>>

Create an indicator by its registered name, or None if not found.

pub fn category(&self, name: &str) -> Option<&'static str>

The category of the indicator registered under name, such as "Momentum" or "Volume" for a built-in and CUSTOM for one added with register, or None if not found or left out of the catalogue.

pub fn list(&self) -> Vec<String>

The names a study picker offers, unordered: every registered name except the exported studies outside the catalogue.

pub fn has(&self, name: &str) -> bool

Whether create resolves name, also one that list leaves out.

pub fn unregister(&mut self, name: &str) -> bool

Remove the indicator registered under name.

Returns true if it was present and removed, false otherwise.

pub fn clear(&mut self)

Remove all registered indicators, including built-ins.

pub fn count(&self) -> usize

The number of names in list.

Trait Implementations

impl Default for IndicatorFactory

fn default() -> Self

Returns the “default value” for a type.