Struct DatabentoImbalance 

pub struct DatabentoImbalance {
    pub instrument_id: InstrumentId,
    pub ref_price: Price,
    pub cont_book_clr_price: Price,
    pub auct_interest_clr_price: Price,
    pub paired_qty: Quantity,
    pub total_imbalance_qty: Quantity,
    pub side: OrderSide,
    pub significant_imbalance: c_char,
    pub ts_event: UnixNanos,
    pub ts_recv: UnixNanos,
    pub ts_init: UnixNanos,
}

Represents an auction imbalance.

This data type includes the populated data fields provided by Databento, excluding publisher_id and instrument_id.

Fields

instrument_id: InstrumentId

ref_price: Price

cont_book_clr_price: Price

auct_interest_clr_price: Price

paired_qty: Quantity

total_imbalance_qty: Quantity

side: OrderSide

significant_imbalance: c_char

ts_event: UnixNanos

ts_recv: UnixNanos

ts_init: UnixNanos

Implementations

impl DatabentoImbalance

pub fn get_metadata( instrument_id: &InstrumentId, price_precision: u8, size_precision: u8, ) -> HashMap<String, String>

Returns the metadata for the type, for use with serialization formats.

pub const fn new( instrument_id: InstrumentId, ref_price: Price, cont_book_clr_price: Price, auct_interest_clr_price: Price, paired_qty: Quantity, total_imbalance_qty: Quantity, side: OrderSide, significant_imbalance: c_char, ts_event: UnixNanos, ts_recv: UnixNanos, ts_init: UnixNanos, ) -> Self

Creates a new DatabentoImbalance instance.

impl DatabentoImbalance

pub fn py_to_dict(&self, py: Python<'_>) -> PyResult<Py<PyAny>>

Errors

Returns a PyErr if generating the Python dictionary fails.

Trait Implementations

impl ArrowSchemaProvider for DatabentoImbalance

fn get_schema(metadata: Option<HashMap<String, String>>) -> Schema

Returns the Arrow schema for this type with optional metadata.

fn get_schema_map() -> HashMap<String, String>

Returns a map of field names to their Arrow data types.

impl Clone for DatabentoImbalance

fn clone(&self) -> DatabentoImbalance

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CustomDataTrait for DatabentoImbalance

fn type_name(&self) -> &'static str

Returns the type name for the custom data.

fn as_any(&self) -> &dyn Any

Returns the data as a dyn Any for downcasting.

fn ts_event(&self) -> UnixNanos

Returns the event timestamp (when the data occurred).

fn to_json(&self) -> Result<String>

Serializes the custom data to a JSON string.

fn clone_arc(&self) -> Arc<dyn CustomDataTrait>

Returns a cloned Arc of the custom data.

fn eq_arc(&self, other: &dyn CustomDataTrait) -> bool

Returns whether the custom data is equal to another.

fn to_pyobject(&self, py: Python<'_>) -> PyResult<Py<PyAny>>

Converts the custom data to a Python object.

fn type_name_static() -> &'static str

Returns the type name used in serialized form (e.g. in the "type" field).

fn from_json(value: Value) -> Result<Arc<dyn CustomDataTrait>>

Deserializes from a JSON value into an Arc’d trait object.

fn to_json_py(&self) -> Result<String, Error>

Python-facing JSON serialization. Default implementation forwards to to_json. Override if a different behavior is needed for the Python API.

impl Debug for DatabentoImbalance

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

Formats the value using the given formatter.

impl DecodeDataFromRecordBatch for DatabentoImbalance

fn decode_data_batch( metadata: &HashMap<String, String>, record_batch: RecordBatch, ) -> Result<Vec<Data>, EncodingError>

Decodes a RecordBatch into raw Data values, using the provided metadata.

impl<'de> Deserialize<'de> for DatabentoImbalance

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl EncodeToRecordBatch for DatabentoImbalance

fn encode_batch( metadata: &HashMap<String, String>, data: &[Self], ) -> Result<RecordBatch, ArrowError>

Encodes a batch of values into an Arrow RecordBatch using the provided metadata.

fn metadata(&self) -> HashMap<String, String>

Returns the metadata for this data element.

fn chunk_metadata(chunk: &[Self]) -> HashMap<String, String>

Returns the metadata for the first element in a chunk.

impl<'a, 'py> FromPyObject<'a, 'py> for DatabentoImbalance

where Self: Clone,

type Error = PyClassGuardError<'a, 'py>

The type returned in the event of a conversion error.

fn extract( obj: Borrowed<'a, 'py, PyAny>, ) -> Result<Self, <Self as FromPyObject<'a, 'py>>::Error>

Extracts Self from the bound smart pointer obj.

impl HasTsInit for DatabentoImbalance

fn ts_init(&self) -> UnixNanos

Returns the UNIX timestamp (nanoseconds) when the instance was created.

impl Hash for DatabentoImbalance

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<'py> IntoPyObject<'py> for DatabentoImbalance

type Target = DatabentoImbalance

The Python output type

type Output = Bound<'py, <DatabentoImbalance as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PartialEq for DatabentoImbalance

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

const NAME: &str = "DatabentoImbalance"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for DatabentoImbalance

const MODULE: Option<&str>

Module which the class will be associated with.

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)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// Represents an auction imbalance. /// /// This data type includes the populated data fields provided by `Databento`, /// excluding `publisher_id` and `instrument_id`.

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type Layout = <<DatabentoImbalance as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<DatabentoImbalance>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForDatabentoImbalance

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 lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<PyObjectOffset>

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyStubType for DatabentoImbalance

fn type_output() -> TypeInfo

The type to be used in the output signature, i.e. return type of the Python function or methods.

fn type_input() -> TypeInfo

The type to be used in the input signature, i.e. the arguments of the Python function or methods.

impl PyTypeInfo for DatabentoImbalance

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

Module name, if any.

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

Returns the PyTypeObject instance for this type.

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

Returns the safe abstraction over the type object.

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

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

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

Checks if object is an instance of this type.

impl Serialize for DatabentoImbalance

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl DerefToPyAny for DatabentoImbalance

impl Eq for DatabentoImbalance

impl StructuralPartialEq for DatabentoImbalance