Enum BarAggregation

#[repr(C)]
pub enum BarAggregation {
    Tick = 1,
    TickImbalance = 2,
    TickRuns = 3,
    Volume = 4,
    VolumeImbalance = 5,
    VolumeRuns = 6,
    Value = 7,
    ValueImbalance = 8,
    ValueRuns = 9,
    Millisecond = 10,
    Second = 11,
    Minute = 12,
    Hour = 13,
    Day = 14,
    Week = 15,
    Month = 16,
}

The aggregation method through which a bar is generated and closed.

Variants

Tick = 1

Based on a number of ticks.

TickImbalance = 2

Based on the buy/sell imbalance of ticks.

TickRuns = 3

Based on sequential buy/sell runs of ticks.

Volume = 4

Based on traded volume.

VolumeImbalance = 5

Based on the buy/sell imbalance of traded volume.

VolumeRuns = 6

Based on sequential runs of buy/sell traded volume.

Value = 7

Based on the ‘notional’ value of the instrument.

ValueImbalance = 8

Based on the buy/sell imbalance of trading by notional value.

ValueRuns = 9

Based on sequential buy/sell runs of trading by notional value.

Millisecond = 10

Based on time intervals with millisecond granularity.

Second = 11

Based on time intervals with second granularity.

Minute = 12

Based on time intervals with minute granularity.

Hour = 13

Based on time intervals with hour granularity.

Day = 14

Based on time intervals with day granularity.

Week = 15

Based on time intervals with week granularity.

Month = 16

Based on time intervals with month granularity.

Implementations

impl BarAggregation

pub const fn from_repr(discriminant: usize) -> Option<BarAggregation>

Try to create Self from the raw representation

impl BarAggregation

pub fn name(&self) -> String

pub fn value(&self) -> u8

Trait Implementations

impl AsRef<str> for BarAggregation

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for BarAggregation

fn clone(&self) -> BarAggregation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BarAggregation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BarAggregation

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for BarAggregation

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

Formats the value using the given formatter.

impl FromStr for BarAggregation

type Err = ParseError

The associated error which can be returned from parsing.

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

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

impl Hash for BarAggregation

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 IntoEnumIterator for BarAggregation

type Iterator = BarAggregationIter

fn iter() -> BarAggregationIter

impl IntoPy<Py<PyAny>> for BarAggregation

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl Ord for BarAggregation

fn cmp(&self, other: &BarAggregation) -> 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 BarAggregation

fn eq(&self, other: &BarAggregation) -> 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 BarAggregation

fn partial_cmp(&self, other: &BarAggregation) -> 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 PyClass for BarAggregation

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for BarAggregation

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<BarAggregation>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn doc(py: Python<'_>) -> PyResult<&'static CStr>

Rendered class doc

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature<BarAggregation> for PyClassImplCollector<BarAggregation>

fn new_text_signature(self) -> Option<&'static str>

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a BarAggregation

type Holder = Option<PyRef<'py, BarAggregation>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder, ) -> PyResult<Self>

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a mut BarAggregation

type Holder = Option<PyRefMut<'py, BarAggregation>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder, ) -> PyResult<Self>

impl PyMethods<BarAggregation> for PyClassImplCollector<BarAggregation>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for BarAggregation

const NAME: &'static str = "BarAggregation"

Class name.

const MODULE: Option<&'static str> = _

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object_bound(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of_bound(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of_bound(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl Serialize for BarAggregation

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for BarAggregation

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<BarAggregation, <Self as TryFrom<&str>>::Error>

Performs the conversion.

impl Copy for BarAggregation

impl Eq for BarAggregation

impl StructuralPartialEq for BarAggregation