Skip to main content

Module arrow

Module arrow 

Source
Expand description

Defines the Apache Arrow schema for Nautilus types.

Modules§

account_state
bar
close
custom
Custom data: registration and dynamic decoding.
delta
depth
display
Display-mode Arrow encoders for Nautilus types.
funding
index_price
instrument
Arrow serialization for instruments.
instrument_status
json
mark_price
order_event
position_event
quote
report
snapshot
trade

Enums§

DataStreamingError
EncodingError
StringColumnRef
Reference to a string column, either Utf8 or Utf8View.

Constants§

KEY_INSTRUMENT_ID
KEY_PRICE_PRECISION
KEY_SIZE_PRECISION

Traits§

ArrowSchemaProvider
Provides Apache Arrow schema definitions for data types.
DecodeDataFromRecordBatch
Decodes raw Data objects from Apache Arrow RecordBatch format.
DecodeFromRecordBatch
Decodes data types from Apache Arrow RecordBatch format.
DecodeTypedFromRecordBatch
Decodes strongly typed values from Apache Arrow RecordBatch format.
EncodeToRecordBatch
Encodes data types to Apache Arrow RecordBatch format.
WriteStream
Writes RecordBatch data to output streams.

Functions§

bars_to_arrow_record_batch_bytes
Converts a vector of Bar into an Arrow RecordBatch.
book_deltas_to_arrow_record_batch_bytes
Converts a vector of OrderBookDelta into an Arrow RecordBatch.
book_depth10_to_arrow_record_batch_bytes
Converts a vector of OrderBookDepth10 into an Arrow RecordBatch.
decode_price
Decodes a [Price] from raw bytes with bounds validation.
decode_price_with_sentinel
Decodes a [Price] from raw bytes, using precision 0 for sentinel values.
decode_quantity
Decodes a [Quantity] from raw bytes with bounds validation.
decode_quantity_with_sentinel
Decodes a [Quantity] from raw bytes, using precision 0 for sentinel values.
extract_column
Extracts and downcasts the specified column_key column from an Arrow array slice.
extract_column_string
Extracts a string column, accepting both Utf8 (StringArray) and Utf8View (StringViewArray). Parquet may return Utf8View when reading, so this handles both formats.
index_prices_to_arrow_record_batch_bytes
Converts a vector of IndexPriceUpdate into an Arrow RecordBatch.
instrument_closes_to_arrow_record_batch_bytes
Converts a vector of InstrumentClose into an Arrow RecordBatch.
instrument_status_to_arrow_record_batch_bytes
Converts a vector of InstrumentStatus into an Arrow RecordBatch.
mark_prices_to_arrow_record_batch_bytes
Converts a vector of MarkPriceUpdate into an Arrow RecordBatch.
quotes_to_arrow_record_batch_bytes
Converts a vector of QuoteTick into an Arrow RecordBatch.
trades_to_arrow_record_batch_bytes
Converts a vector of TradeTick into an Arrow RecordBatch.
validate_precision_bytes
Validates that a [FixedSizeBinaryArray] has the expected precision byte width.