Struct arrow_flight::FlightInfo

pub struct FlightInfo {
    pub schema: Bytes,
    pub flight_descriptor: Option<FlightDescriptor>,
    pub endpoint: Vec<FlightEndpoint>,
    pub total_records: i64,
    pub total_bytes: i64,
}

The access coordinates for retrieval of a dataset. With a FlightInfo, a consumer is able to determine how to retrieve a dataset.

Fields

schema: Bytes

The schema of the dataset in its IPC form: 4 bytes - an optional IPC_CONTINUATION_TOKEN prefix 4 bytes - the byte length of the payload a flatbuffer Message whose header is the Schema

flight_descriptor: Option<FlightDescriptor>

The descriptor associated with this info.

endpoint: Vec<FlightEndpoint>

A list of endpoints associated with the flight. To consume the whole flight, all endpoints (and hence all Tickets) must be consumed. Endpoints can be consumed in any order.

In other words, an application can use multiple endpoints to represent partitioned data.

There is no ordering defined on endpoints. Hence, if the returned data has an ordering, it should be returned in a single endpoint.

total_records: i64

Set these to -1 if unknown.

total_bytes: i64

Implementations

impl FlightInfo

pub fn new(
    message: IpcMessage,
    flight_descriptor: Option<FlightDescriptor>,
    endpoint: Vec<FlightEndpoint>,
    total_records: i64,
    total_bytes: i64
) -> Self

pub fn try_decode_schema(self) -> Result<Schema, ArrowError>

Try and convert the data in this FlightInfo into a Schema

Trait Implementations

impl Clone for FlightInfo

fn clone(&self) -> FlightInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FlightInfo

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

Formats the value using the given formatter.

impl Default for FlightInfo

fn default() -> Self

Returns the “default value” for a type.

impl Display for FlightInfo

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

Formats the value using the given formatter.

impl Message for FlightInfo

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<FlightInfo> for FlightInfo

fn eq(&self, other: &FlightInfo) -> 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<FlightInfo> for Schema

type Error = ArrowError

The type returned in the event of a conversion error.

fn try_from(value: FlightInfo) -> Result<Self, ArrowError>

Performs the conversion.

impl StructuralPartialEq for FlightInfo