Struct arrow_flight::FlightData
source · pub struct FlightData {
pub flight_descriptor: Option<FlightDescriptor>,
pub data_header: Bytes,
pub app_metadata: Bytes,
pub data_body: Bytes,
}
Expand description
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§
source§impl FlightData
impl FlightData
sourcepub fn new() -> Self
pub fn new() -> Self
Create a new FlightData
.
§See Also
See FlightDataEncoderBuilder
for a higher level API to
convert a stream of RecordBatch
es to FlightData
s
§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);
sourcepub fn with_descriptor(self, flight_descriptor: FlightDescriptor) -> Self
pub fn with_descriptor(self, flight_descriptor: FlightDescriptor) -> Self
Add a FlightDescriptor
describing the data
sourcepub fn with_data_header(self, data_header: impl Into<Bytes>) -> Self
pub fn with_data_header(self, data_header: impl Into<Bytes>) -> Self
Add a data header
sourcepub fn with_data_body(self, data_body: impl Into<Bytes>) -> Self
pub fn with_data_body(self, data_body: impl Into<Bytes>) -> Self
Add a data body. See IpcDataGenerator
to create this data.
sourcepub fn with_app_metadata(self, app_metadata: impl Into<Bytes>) -> Self
pub fn with_app_metadata(self, app_metadata: impl Into<Bytes>) -> Self
Add optional application specific metadata to the message
Trait Implementations§
source§impl Clone for FlightData
impl Clone for FlightData
source§fn clone(&self) -> FlightData
fn clone(&self) -> FlightData
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for FlightData
impl Debug for FlightData
source§impl Default for FlightData
impl Default for FlightData
source§impl Display for FlightData
impl Display for FlightData
source§impl From<EncodedData> for FlightData
impl From<EncodedData> for FlightData
source§fn from(data: EncodedData) -> Self
fn from(data: EncodedData) -> Self
source§impl From<SchemaAsIpc<'_>> for FlightData
impl From<SchemaAsIpc<'_>> for FlightData
source§fn from(schema_ipc: SchemaAsIpc<'_>) -> Self
fn from(schema_ipc: SchemaAsIpc<'_>) -> Self
source§impl Message for FlightData
impl Message for FlightData
source§fn encoded_len(&self) -> usize
fn encoded_len(&self) -> usize
source§fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>
fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>
source§fn encode_to_vec(&self) -> Vec<u8>where
Self: Sized,
fn encode_to_vec(&self) -> Vec<u8>where
Self: Sized,
source§fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>
fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>
source§fn encode_length_delimited_to_vec(&self) -> Vec<u8>where
Self: Sized,
fn encode_length_delimited_to_vec(&self) -> Vec<u8>where
Self: Sized,
source§fn decode<B>(buf: B) -> Result<Self, DecodeError>
fn decode<B>(buf: B) -> Result<Self, DecodeError>
source§fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>
source§fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>
fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>
self
. Read moresource§fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>
fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>
self
.source§impl PartialEq for FlightData
impl PartialEq for FlightData
source§fn eq(&self, other: &FlightData) -> bool
fn eq(&self, other: &FlightData) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl TryFrom<&FlightData> for Schema
impl TryFrom<&FlightData> for Schema
§type Error = ArrowError
type Error = ArrowError
source§fn try_from(data: &FlightData) -> Result<Self, ArrowError>
fn try_from(data: &FlightData) -> Result<Self, ArrowError>
impl StructuralPartialEq for FlightData
Auto Trait Implementations§
impl !Freeze for FlightData
impl RefUnwindSafe for FlightData
impl Send for FlightData
impl Sync for FlightData
impl Unpin for FlightData
impl UnwindSafe for FlightData
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T
in a tonic::Request