Struct arrow_flight::FlightEndpoint

pub struct FlightEndpoint {
    pub ticket: Option<Ticket>,
    pub location: Vec<Location>,
    pub expiration_time: Option<Timestamp>,
    pub app_metadata: Bytes,
}

A particular stream or split associated with a flight.

Fields

ticket: Option<Ticket>

Token used to retrieve this stream.

location: Vec<Location>

A list of URIs where this ticket can be redeemed via DoGet().

If the list is empty, the expectation is that the ticket can only be redeemed on the current service where the ticket was generated.

If the list is not empty, the expectation is that the ticket can be redeemed at any of the locations, and that the data returned will be equivalent. In this case, the ticket may only be redeemed at one of the given locations, and not (necessarily) on the current service.

In other words, an application can use multiple locations to represent redundant and/or load balanced services.

expiration_time: Option<Timestamp>

Expiration time of this stream. If present, clients may assume they can retry DoGet requests. Otherwise, it is application-defined whether DoGet requests may be retried.

app_metadata: Bytes

Application-defined metadata.

There is no inherent or required relationship between this and the app_metadata fields in the FlightInfo or resulting FlightData messages. Since this metadata is application-defined, a given application could define there to be a relationship, but there is none required by the spec.

Implementations

impl FlightEndpoint

pub fn new() -> FlightEndpoint

Create a new, empty FlightEndpoint that represents a location to retrieve Flight results.

Example

// Specify the client should fetch results from this server
let endpoint = FlightEndpoint::new()
  .with_ticket(Ticket::new("the ticket"));

// Specify the client should fetch results from either
// `http://example.com` or `https://example.com`
let endpoint = FlightEndpoint::new()
  .with_ticket(Ticket::new("the ticket"))
  .with_location("http://example.com")
  .with_location("https://example.com");

pub fn with_ticket(self, ticket: Ticket) -> Self

Set the Ticket used to retrieve data from the endpoint

pub fn with_location(self, uri: impl Into<String>) -> Self

Add a location uri to this endpoint. Note each endpoint can have multiple locations.

If no uri is specified, the Flight Spec says:

* If the list is empty, the expectation is that the ticket can only
* be redeemed on the current service where the ticket was
* generated.

pub fn with_expiration_time(self, expiration_time: Timestamp) -> Self

Specify expiration time for this stream

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 FlightEndpoint

fn clone(&self) -> FlightEndpoint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FlightEndpoint

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

Formats the value using the given formatter.

impl Default for FlightEndpoint

fn default() -> Self

Returns the “default value” for a type.

impl Display for FlightEndpoint

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

Formats the value using the given formatter.

impl Message for FlightEndpoint

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>

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>

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

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