Enum ql2::response::ResponseNote

#[repr(i32)]pub enum ResponseNote {
    SequenceFeed,
    AtomFeed,
    OrderByLimitFeed,
    UnionedFeed,
    IncludesStates,
}

ResponseNotes are used to provide information about the query response that may be useful for people writing drivers or ORMs. Currently all the notes we send indicate that a stream has certain special properties.

Variants

SequenceFeed

The stream is a changefeed stream (e.g. r.table('test').changes()).

AtomFeed

The stream is a point changefeed stream (e.g. r.table('test').get(0).changes()).

OrderByLimitFeed

The stream is an order_by_limit changefeed stream (e.g. r.table('test').order_by(index: 'id').limit(5).changes()).

UnionedFeed

The stream is a union of multiple changefeed types that can’t be collapsed to a single type (e.g. r.table('test').changes().union(r.table('test').get(0).changes())).

IncludesStates

The stream is a changefeed stream and includes notes on what state the changefeed stream is in (e.g. objects of the form {state: 'initializing'}).

Implementations

impl ResponseNote

pub fn is_valid(value: i32) -> bool

Returns true if value is a variant of ResponseNote.

pub fn from_i32(value: i32) -> Option<ResponseNote>

Converts an i32 to a ResponseNote, or None if value is not a valid variant.

Trait Implementations

impl Clone for ResponseNote

fn clone(&self) -> ResponseNote

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ResponseNote

impl Debug for ResponseNote

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

Formats the value using the given formatter.

impl Default for ResponseNote

fn default() -> ResponseNote

Returns the “default value” for a type.

impl Eq for ResponseNote

impl Hash for ResponseNote

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for ResponseNote

fn cmp(&self, other: &ResponseNote) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<ResponseNote> for ResponseNote

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<ResponseNote> for ResponseNote

fn partial_cmp(&self, other: &ResponseNote) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for ResponseNote

impl StructuralPartialEq for ResponseNote