Trait EncodeToRecordBatch

pub trait EncodeToRecordBatch
where
    Self: Sized + ArrowSchemaProvider,
{
    // Required methods
    fn encode_batch(
        metadata: &HashMap<String, String>,
        data: &[Self],
    ) -> Result<RecordBatch, ArrowError>;
    fn metadata(&self) -> HashMap<String, String>;

    // Provided method
    fn chunk_metadata(chunk: &[Self]) -> HashMap<String, String> { ... }
}

Encodes data types to Apache Arrow RecordBatch format.

Required Methods

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.

Errors

Returns an ArrowError if the encoding fails.

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

Returns the metadata for this data element.

Provided Methods

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

Returns the metadata for the first element in a chunk.

Panics

Panics if chunk is empty.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl EncodeToRecordBatch for Bar

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

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

impl EncodeToRecordBatch for IndexPriceUpdate

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

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

impl EncodeToRecordBatch for InstrumentClose

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

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

impl EncodeToRecordBatch for MarkPriceUpdate

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

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

impl EncodeToRecordBatch for OrderBookDelta

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

Extract metadata from first two deltas

Use the second delta if the first one has 0 precision

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

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

impl EncodeToRecordBatch for OrderBookDepth10

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

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

impl EncodeToRecordBatch for QuoteTick

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

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

impl EncodeToRecordBatch for TradeTick

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

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

Implementors