Struct FilterDefinition

pub struct FilterDefinition { /* private fields */ }

The main filter definition

This is the main handle for Txn Filter definition, and this can be used to serialize and deserialize filters from JSON.

Examples

let filter_json_str = r#"{"txnFilter":{"NullaryTRUE":{}}}"#;

let tf = serde_json::from_str::<FilterDefinition>(filter_json_str)?;

match tf.txn_filter {
     TxnFilter::NullaryTRUE(_) => (),
     _ => panic!(),
}

assert_eq!(serde_json::to_string(&tf)?, filter_json_str);

Implementations

impl FilterDefinition

pub fn from_json_str(filt_str: &str) -> Result<FilterDefinition, Error>

Generate filter from JSON String

Errors

Return Err if the filter definition is not valid

Examples

let filter_json_str = r#"{"txnFilter":{"NullaryTRUE":{}}}"#;

let tf = FilterDefinition::from_json_str(filter_json_str)?;

match tf.txn_filter {
     TxnFilter::NullaryTRUE(_) => (),
     _ => panic!(),
}

pub fn is_armored(filt: &str) -> bool

Test if filter string is ascii armored

pub fn from_armor(filt_armor_str: &str) -> Result<FilterDefinition, Error>

Generate filter from ascii armor JSON String

The ascii armor must be be prefixed with base64

Errors

Returns Err if the filter definition is not valid or encoding is unknown

Examples

let filter_ascii_armor = "base64:eyJ0eG5GaWx0ZXIiOnsiTnVsbGFyeVRSVUUiOnt9fX0K";

let tf = FilterDefinition::from_armor(filter_ascii_armor)?;

match tf.txn_filter {
     TxnFilter::NullaryTRUE(_) => (),
     _ => panic!(),
}

Trait Implementations

impl Clone for FilterDefinition

fn clone(&self) -> FilterDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FilterDefinition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FilterDefinition

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for FilterDefinition

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

where __S: Serializer,

Serialize this value into the given Serde serializer.