Struct tendermint_rpc::query::Query

source · [−]

pub struct Query { /* private fields */ }

Expand description

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));

Implementations

impl Query

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

Query constructor testing whether <key> = <value>

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

Query constructor testing whether <key> < <value>

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

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

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

Query constructor testing whether <key> > <value>

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

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

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

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) -> Self

Query constructor testing whether <key> EXISTS.

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

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

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

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

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

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

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

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

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

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

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

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

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

Add the condition <key> EXISTS to the query.

Trait Implementations

impl Clone for Query

fn clone(&self) -> Query

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

impl Debug for Query

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

Formats the value using the given formatter. Read more

impl Default for Query

fn default() -> Self

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

impl Display for Query

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

Formats the value using the given formatter. Read more

impl From<EventType> for Query

fn from(t: EventType) -> Self

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<Self, Self::Err>

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

impl PartialEq<Query> for Query

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

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

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

This method tests for !=.

impl StructuralPartialEq for Query

Auto Trait Implementations

impl RefUnwindSafe for Query

impl Send for Query

impl Sync for Query

impl Unpin for Query

impl UnwindSafe for Query

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

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

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

const: unstable · 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.

impl<T> Same<T> for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

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

default fn to_string(&self) -> String

Converts the given value to a String. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

const: unstable · 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