Struct ql2::Term

pub struct Term {
    pub type: Option<i32>,
    pub datum: Option<Datum>,
    pub args: Vec<Term>,
    pub optargs: Vec<AssocPair>,
}

A [Term] is either a piece of data (see Datum above), or an operator and its operands. If you have a [Datum], it’s stored in the member [datum]. If you have an operator, its positional arguments are stored in [args] and its optional arguments are stored in [optargs].

A note about type signatures: We use the following notation to denote types: arg1_type, arg2_type, argrest_type… -> result_type So, for example, if we have a function avg that takes any number of arguments and averages them, we might write: NUMBER… -> NUMBER Or if we had a function that took one number modulo another: NUMBER, NUMBER -> NUMBER Or a function that takes a table and a primary key of any Datum type, then retrieves the entry with that primary key: Table, DATUM -> OBJECT Some arguments must be provided as literal values (and not the results of sub terms). These are marked with a !. Optional arguments are specified within curly braces as argname : value type (e.x {noreply:BOOL}) Many RQL operations are polymorphic. For these, alterantive type signatures are separated by |.

The RQL type hierarchy is as follows: Top DATUM NULL BOOL NUMBER STRING OBJECT SingleSelection ARRAY Sequence ARRAY Stream StreamSelection Table Database Function Ordering - used only by ORDER_BY Pathspec – an object, string, or array that specifies a path Error

Fields

type: Option<i32>

datum: Option<Datum>

This is only used when type is DATUM.

args: Vec<Term>

Holds the positional arguments of the query.

optargs: Vec<AssocPair>

Holds the optional arguments of the query.

Implementations

impl Term

pub fn type(&self) -> TermType

Returns the enum value of type, or the default if the field is unset or set to an invalid enum value.

pub fn set_type(&mut self, value: TermType)

Sets type to the provided enum value.

Trait Implementations

impl Clone for Term

fn clone(&self) -> Term

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Term

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

Formats the value using the given formatter.

impl Default for Term

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Term

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Message for Term

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, 

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8, Global>

Encodes the message to a newly allocated buffer.

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

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8, Global>

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, 

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, 

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

impl PartialEq<Term> for Term

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

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

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

This method tests for !=.

impl Serialize for Term

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Term