Struct arrow_flight::FlightData

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

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: Bytes

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

app_metadata: Bytes

Application-defined metadata.

data_body: Bytes

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

Implementations

impl FlightData

pub fn new() -> Self

Create a new FlightData.

See Also

See FlightDataEncoderBuilder for a higher level API to convert a stream of RecordBatches to FlightDatas

Example:

// Get encoded Arrow IPC data:
let data_body: Bytes = encode_data();
// Create the FlightData message
let flight_data = FlightData::new()
  .with_descriptor(FlightDescriptor::new_cmd("the command"))
  .with_app_metadata("My apps metadata")
  .with_data_body(data_body);

pub fn with_descriptor(self, flight_descriptor: FlightDescriptor) -> Self

Add a FlightDescriptor describing the data

pub fn with_data_header(self, data_header: impl Into<Bytes>) -> Self

Add a data header

pub fn with_data_body(self, data_body: impl Into<Bytes>) -> Self

Add a data body. See IpcDataGenerator to create this data.

pub fn with_app_metadata(self, app_metadata: impl Into<Bytes>) -> Self

Add optional application specific metadata to the message

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() -> Self

Returns the “default value” for a type.

impl Display for FlightData

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

Formats the value using the given formatter.

impl From<EncodedData> for FlightData

fn from(data: EncodedData) -> Self

Converts to this type from the input type.

impl From<SchemaAsIpc<'_>> for FlightData

fn from(schema_ipc: SchemaAsIpc<'_>) -> Self

Converts to this type from the input type.

impl Message for FlightData

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, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8, Global>where Self: Sized,

Encodes the message to a newly allocated buffer.

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

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

fn encode_length_delimited_to_vec(&self) -> Vec<u8, Global>where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated 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, Self: Sized,

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, Self: Sized,

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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&FlightData> for Schema

type Error = ArrowError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl StructuralPartialEq for FlightData