arrow_flight::gen

Struct PollInfo

Source
pub struct PollInfo {
    pub info: Option<FlightInfo>,
    pub flight_descriptor: Option<FlightDescriptor>,
    pub progress: Option<f64>,
    pub expiration_time: Option<Timestamp>,
}
Expand description

The information to process a long-running query.

Fields§

§info: Option<FlightInfo>

The currently available results.

If “flight_descriptor” is not specified, the query is complete and “info” specifies all results. Otherwise, “info” contains partial query results.

Note that each PollInfo response contains a complete FlightInfo (not just the delta between the previous and current FlightInfo).

Subsequent PollInfo responses may only append new endpoints to info.

Clients can begin fetching results via DoGet(Ticket) with the ticket in the info before the query is completed. FlightInfo.ordered is also valid.

§flight_descriptor: Option<FlightDescriptor>

The descriptor the client should use on the next try. If unset, the query is complete.

§progress: Option<f64>

Query progress. If known, must be in [0.0, 1.0] but need not be monotonic or nondecreasing. If unknown, do not set.

§expiration_time: Option<Timestamp>

Expiration time for this request. After this passes, the server might not accept the retry descriptor anymore (and the query may be cancelled). This may be updated on a call to PollFlightInfo.

Implementations§

Source§

impl PollInfo

Source

pub fn progress(&self) -> f64

Returns the value of progress, or the default value if progress is unset.

Source§

impl PollInfo

Source

pub fn new() -> Self

Create a new, empty PollInfo, providing information for a long-running query

§Example:
// Create a new PollInfo
let poll_info = PollInfo::new()
  .with_info(FlightInfo::new())
  .with_descriptor(FlightDescriptor::new_cmd("RUN QUERY"))
  .try_with_progress(0.5)
  .expect("progress should've been valid")
  .with_expiration_time(
    "1970-01-01".parse().expect("invalid timestamp")
  );
Source

pub fn with_info(self, info: FlightInfo) -> Self

Add the current available results for the poll call as a FlightInfo

Source

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

Add a FlightDescriptor that the client should use for the next poll call, if the query is not yet complete

Source

pub fn try_with_progress(self, progress: f64) -> Result<Self, ArrowError>

Set the query progress if known. Must be in the range [0.0, 1.0] else this will return an error

Source

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

Specify expiration time for this request

Trait Implementations§

Source§

impl Clone for PollInfo

Source§

fn clone(&self) -> PollInfo

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PollInfo

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for PollInfo

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Display for PollInfo

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Message for PollInfo

Source§

fn encoded_len(&self) -> usize

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

fn clear(&mut self)

Clears the message, resetting all fields to their default.
Source§

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

Encodes the message to a buffer. Read more
Source§

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

Encodes the message to a newly allocated buffer.
Source§

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

Encodes the message with a length-delimiter to a buffer. Read more
Source§

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

Encodes the message with a length-delimiter to a newly allocated buffer.
Source§

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

Decodes an instance of the message from a buffer. Read more
Source§

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

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

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

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

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

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

impl PartialEq for PollInfo

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for PollInfo

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FromRef<T> for T
where T: Clone,

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,