Struct EventFilter 

#[non_exhaustive]
pub struct EventFilter {
    pub terms: Vec<EventTerm>,
}

DNF filter for events: any term may match, and each term is an AND of signed literals. Sender predicates match all events from matching transactions; emit-module, event-type, and event-stream-head predicates match individual event-space dimensions. An absent filter matches everything. A present filter must have at least one term.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

terms: Vec<EventTerm>

Terms are ORed together.

Implementations

impl EventFilter

pub const TERMS_FIELD: &'static MessageField

impl EventFilter

pub fn path_builder() -> EventFilterFieldPathBuilder

impl EventFilter

pub const fn const_default() -> Self

pub fn terms(&self) -> &[EventTerm]

Returns the value of terms, or the default value if terms is unset.

pub fn terms_mut(&mut self) -> &mut Vec<EventTerm>

Returns a mutable reference to terms. If the field is unset, it is first initialized with the default value.

pub fn set_terms(&mut self, field: Vec<EventTerm>)

Sets terms with the provided value.

pub fn with_terms(self, field: Vec<EventTerm>) -> Self

Sets terms with the provided value.

impl EventFilter

pub fn any(terms: impl IntoIterator<Item = impl Into<EventTerm>>) -> Self

A filter matching events that satisfy any one of terms (the terms are ORed together).

pub fn all(literals: impl IntoIterator<Item = impl Into<EventLiteral>>) -> Self

A filter with a single term matching events that satisfy every one of literals.

pub fn matching(literal: impl Into<EventLiteral>) -> Self

A filter matching events that satisfy a single literal.

Trait Implementations

impl Clone for EventFilter

fn clone(&self) -> EventFilter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EventFilter

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

Formats the value using the given formatter.

impl Default for EventFilter

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EventFilter

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for EventFilter

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(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

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

where Self: Sized,

Encodes the message to a newly allocated buffer.

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

where Self: Sized,

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

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

where Self: Sized,

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

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

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

impl MessageFields for EventFilter

const FIELDS: &'static [&'static MessageField]

impl PartialEq for EventFilter

fn eq(&self, other: &EventFilter) -> 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 Serialize for EventFilter

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 EventFilter