Struct Query 

pub struct Query {
    pub event_type: Option<EventType>,
    pub conditions: Vec<Condition>,
}

A structured query for use in interacting with the Tendermint RPC event subscription system.

Allows for compile-time validation of queries.

See the subscribe endpoint documentation for more details.

Examples

Direct construction of queries

use tendermint_rpc::query::{Query, EventType};

let query = Query::from(EventType::NewBlock);
assert_eq!("tm.event = 'NewBlock'", query.to_string());

let query = Query::from(EventType::Tx).and_eq("tx.hash", "XYZ");
assert_eq!("tm.event = 'Tx' AND tx.hash = 'XYZ'", query.to_string());

let query = Query::from(EventType::Tx).and_gte("tx.height", 100_u64);
assert_eq!("tm.event = 'Tx' AND tx.height >= 100", query.to_string());

Query parsing

use tendermint_rpc::query::{Query, EventType};

let query: Query = "tm.event = 'NewBlock'".parse().unwrap();
assert_eq!(query, Query::from(EventType::NewBlock));

let query: Query = "tm.event = 'Tx' AND tx.hash = 'XYZ'".parse().unwrap();
assert_eq!(query, Query::from(EventType::Tx).and_eq("tx.hash", "XYZ"));

let query: Query = "tm.event = 'Tx' AND tx.height >= 100".parse().unwrap();
assert_eq!(query, Query::from(EventType::Tx).and_gte("tx.height", 100_u64));

Fields

event_type: Option<EventType>

conditions: Vec<Condition>

Implementations

impl Query

pub fn eq(key: impl ToString, value: impl Into<Operand>) -> Query

Query constructor testing whether <key> = <value>

pub fn lt(key: impl ToString, value: impl Into<Operand>) -> Query

Query constructor testing whether <key> < <value>

pub fn lte(key: impl ToString, value: impl Into<Operand>) -> Query

Query constructor testing whether <key> <= <value>

pub fn gt(key: impl ToString, value: impl Into<Operand>) -> Query

Query constructor testing whether <key> > <value>

pub fn gte(key: impl ToString, value: impl Into<Operand>) -> Query

Query constructor testing whether <key> >= <value>

pub fn contains(key: impl ToString, value: impl ToString) -> Query

Query constructor testing whether <key> CONTAINS <value> (assuming key contains a string, this tests whether value is a sub-string within it).

pub fn exists(key: impl ToString) -> Query

Query constructor testing whether <key> EXISTS.

pub fn and_eq(self, key: impl ToString, value: impl Into<Operand>) -> Query

Add the condition <key> = <value> to the query.

pub fn and_lt(self, key: impl ToString, value: impl Into<Operand>) -> Query

Add the condition <key> < <value> to the query.

pub fn and_lte(self, key: impl ToString, value: impl Into<Operand>) -> Query

Add the condition <key> <= <value> to the query.

pub fn and_gt(self, key: impl ToString, value: impl Into<Operand>) -> Query

Add the condition <key> > <value> to the query.

pub fn and_gte(self, key: impl ToString, value: impl Into<Operand>) -> Query

Add the condition <key> >= <value> to the query.

pub fn and_contains(self, key: impl ToString, value: impl ToString) -> Query

Add the condition <key> CONTAINS <value> to the query.

pub fn and_exists(self, key: impl ToString) -> Query

Add the condition <key> EXISTS to the query.

Trait Implementations

impl Clone for Query

fn clone(&self) -> Query

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Query

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

Formats the value using the given formatter.

impl Default for Query

fn default() -> Query

An empty query matches any set of events. See these docs.

impl Display for Query

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

Formats the value using the given formatter.

impl From<EventType> for Query

fn from(t: EventType) -> Query

Converts to this type from the input type.

impl FromStr for Query

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Query, <Query as FromStr>::Err>

Parses a string s to return a value of this type.

impl PartialEq for Query

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Query