Struct arrow_flight::FlightData

pub struct FlightData {
    pub flight_descriptor: Option<FlightDescriptor>,
    pub data_header: Vec<u8>,
    pub app_metadata: Vec<u8>,
    pub data_body: Vec<u8>,
}

A batch of Arrow data as part of a stream of batches.

Fields

flight_descriptor: Option<FlightDescriptor>

The descriptor of the data. This is only relevant when a client is starting a new DoPut stream.

data_header: Vec<u8>

Header for message data as described in Message.fbs::Message.

app_metadata: Vec<u8>

Application-defined metadata.

data_body: Vec<u8>

The actual batch of Arrow data. Preferably handled with minimal-copies coming last in the definition to help with sidecar patterns (it is expected that some implementations will fetch this field off the wire with specialized code to avoid extra memory copies).

Trait Implementations

impl Clone for FlightData

fn clone(&self) -> FlightData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FlightData

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

Formats the value using the given formatter.

impl Default for FlightData

fn default() -> FlightData

Returns the "default value" for a type.

impl<'_> From<&'_ RecordBatch> for FlightData

Convert a RecordBatch to FlightData by converting the header and body to bytes

Note: This implicitly uses the default IpcWriteOptions. To configure options, use flight_data_from_arrow_batch()

fn from(batch: &RecordBatch) -> Self

Performs the conversion.

impl<'_> From<&'_ Schema> for FlightData

Convert a Schema to FlightData by converting to an IPC message

Note: This implicitly uses the default IpcWriteOptions. To configure options, use flight_data_from_arrow_schema()

fn from(schema: &Schema) -> Self

Performs the conversion.

impl Message for FlightData

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<FlightData> for FlightData

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for FlightData

impl<'_> TryFrom<&'_ FlightData> for Schema

Try convert FlightData into an Arrow Schema

Returns an error if the FlightData header is not a valid IPC schema

type Error = ArrowError

The type returned in the event of a conversion error.

fn try_from(data: &FlightData) -> Result<Self>

Performs the conversion.