Enum BarType 

#[repr(C)]
pub enum BarType {
    Standard {
        instrument_id: InstrumentId,
        spec: BarSpecification,
        aggregation_source: AggregationSource,
    },
    Composite {
        instrument_id: InstrumentId,
        spec: BarSpecification,
        aggregation_source: AggregationSource,
        composite_step: usize,
        composite_aggregation: BarAggregation,
        composite_aggregation_source: AggregationSource,
    },
}

Represents a bar type including the instrument ID, bar specification and aggregation source.

Variants

Standard

Fields

instrument_id: InstrumentId

The bar type’s instrument ID.

spec: BarSpecification

The bar type’s specification.

aggregation_source: AggregationSource

The bar type’s aggregation source.

Composite

Fields

instrument_id: InstrumentId

The bar type’s instrument ID.

spec: BarSpecification

The bar type’s specification.

aggregation_source: AggregationSource

The bar type’s aggregation source.

composite_step: usize

The composite step for binning samples for bar aggregation.

composite_aggregation: BarAggregation

The composite type of bar aggregation.

composite_aggregation_source: AggregationSource

The composite bar type’s aggregation source.

Implementations

impl BarType

pub fn new( instrument_id: InstrumentId, spec: BarSpecification, aggregation_source: AggregationSource, ) -> Self

Creates a new BarType instance.

pub fn new_composite( instrument_id: InstrumentId, spec: BarSpecification, aggregation_source: AggregationSource, composite_step: usize, composite_aggregation: BarAggregation, composite_aggregation_source: AggregationSource, ) -> Self

Creates a new composite BarType instance.

pub fn is_standard(&self) -> bool

Returns whether this instance is a standard bar type.

pub fn is_composite(&self) -> bool

Returns whether this instance is a composite bar type.

pub fn is_externally_aggregated(&self) -> bool

Returns whether the bar aggregation source is EXTERNAL.

pub fn is_internally_aggregated(&self) -> bool

Returns whether the bar aggregation source is INTERNAL.

pub fn standard(&self) -> Self

Returns the standard bar type component.

pub fn composite(&self) -> Self

Returns any composite bar type component.

pub fn instrument_id(&self) -> InstrumentId

Returns the InstrumentId for this bar type.

pub fn spec(&self) -> BarSpecification

Returns the BarSpecification for this bar type.

pub fn aggregation_source(&self) -> AggregationSource

Returns the AggregationSource for this bar type.

pub fn id_spec_key(&self) -> (InstrumentId, BarSpecification)

Returns the instrument ID and bar specification as a tuple key.

Useful as a hashmap key when aggregation source should be ignored, such as for indicator registration where INTERNAL and EXTERNAL bars should trigger the same indicators.

Trait Implementations

impl Clone for BarType

fn clone(&self) -> BarType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for BarType

impl Debug for BarType

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BarType

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for BarType

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

Formats the value using the given formatter.

impl Eq for BarType

impl<T: AsRef<str>> From<T> for BarType

fn from(value: T) -> Self

Converts to this type from the input type.

impl FromStr for BarType

type Err = BarTypeParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for BarType

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for BarType

fn cmp(&self, other: &BarType) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for BarType

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for BarType

fn partial_cmp(&self, other: &BarType) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for BarType

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for BarType