Skip to main content

OutputSpec

Struct OutputSpec 

Source
pub struct OutputSpec {
    pub name: &'static str,
    pub kind: OutputKind,
    pub color: Option<Rgba>,
    pub shift: i32,
    pub fill_to: Option<(usize, BandOptions)>,
}
Expand description

One output of an indicator.

Fields§

§name: &'static str

Short name, e.g. "signal".

§kind: OutputKind

How it is drawn.

§color: Option<Rgba>

Default color; None picks one from the chart’s palette.

§shift: i32

Display shift in bars (SeriesOptions::shift): positive values are drawn later (Ichimoku’s leading spans), negative ones earlier.

§fill_to: Option<(usize, BandOptions)>

Fill from this output to output .0 (a band), e.g. between Bollinger’s upper and lower lines; see Chart::indicator_bands.

Implementations§

Source§

impl OutputSpec

Source

pub const fn line(name: &'static str) -> Self

A line output with no default color and no shift.

§Examples
use ferrochart_core::plugin::{OutputKind, OutputSpec};

let spec = OutputSpec::line("sma");
assert_eq!((spec.kind, spec.shift), (OutputKind::Line, 0));
Source

pub const fn histogram(name: &'static str) -> Self

A histogram output with no default color and no shift.

Trait Implementations§

Source§

impl Clone for OutputSpec

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for OutputSpec

Source§

impl Debug for OutputSpec

Source§

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

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

impl PartialEq for OutputSpec

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for OutputSpec

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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.