Skip to main content

BarInput

Struct BarInput 

Source
pub struct BarInput {
    pub close: Decimal,
    pub high: Decimal,
    pub low: Decimal,
    pub open: Decimal,
    pub volume: Decimal,
}
Expand description

Thin input type for signal computation, decoupled from OhlcvBar.

Carrying all four price fields and volume allows future indicators (e.g. MACD on high-low, OBV on volume) without forcing a dependency on OhlcvBar.

Fields§

§close: Decimal

Closing price (used by most indicators).

§high: Decimal

High price of the bar.

§low: Decimal

Low price of the bar.

§open: Decimal

Opening price of the bar.

§volume: Decimal

Total traded volume during the bar.

Implementations§

Source§

impl BarInput

Source

pub fn new( close: Decimal, high: Decimal, low: Decimal, open: Decimal, volume: Decimal, ) -> Self

Constructs a BarInput with all fields explicitly specified.

Source

pub fn from_close(close: Decimal) -> Self

Constructs a BarInput from a single close price, setting all OHLC fields to close and volume to zero. Useful in tests and for close-only indicators (SMA/EMA/RSI).

Source

pub fn typical_price(&self) -> Decimal

Returns the typical price of this bar: (high + low + close) / 3.

Source

pub fn weighted_close(&self) -> Decimal

Returns the weighted close price: (high + low + close + close) / 4.

Weights the close twice, giving it extra significance compared to the typical price. Used by some indicators (e.g. CCI variants) and charting systems as a price reference.

Trait Implementations§

Source§

impl Clone for BarInput

Source§

fn clone(&self) -> BarInput

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for BarInput

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<&OhlcvBar> for BarInput

Source§

fn from(bar: &OhlcvBar) -> Self

Converts to this type from the input type.
Source§

impl Copy for BarInput

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.