Skip to main content

SubscriptionFilter

wowlab_centrifuge::filter

Struct SubscriptionFilter 

Source 
pub struct SubscriptionFilter(FilterExpression);
Expand description

A validated server-side publication tag filter.

Tuple Fields§

§0: FilterExpression

Implementations§

Source§

impl SubscriptionFilter

Source

pub fn equal( key: impl Into<String>, value: FilterValue, ) -> Result<Self, FilterError>

Matches tags whose value equals value.

§Errors

Returns an error if the key or required value is empty.

Source

pub fn not_equal( key: impl Into<String>, value: FilterValue, ) -> Result<Self, FilterError>

Matches tags whose value does not equal value.

§Errors

Returns an error if the key or required value is empty.

Source

pub fn is_in<I>(key: impl Into<String>, values: I) -> Result<Self, FilterError>
where I: IntoIterator<Item = FilterValue>,

Matches tags whose value is present in values.

§Errors

Returns an error if the key or value list is empty.

Source

pub fn is_not_in<I>( key: impl Into<String>, values: I, ) -> Result<Self, FilterError>
where I: IntoIterator<Item = FilterValue>,

Matches tags whose value is absent from values.

§Errors

Returns an error if the key or value list is empty.

Source

pub fn exists(key: impl Into<String>) -> Result<Self, FilterError>

Matches publications containing key.

§Errors

Returns an error if the key is empty.

Source

pub fn not_exists(key: impl Into<String>) -> Result<Self, FilterError>

Matches publications that do not contain key.

§Errors

Returns an error if the key is empty.

Source

pub fn starts_with( key: impl Into<String>, value: FilterValue, ) -> Result<Self, FilterError>

Matches text tags beginning with value.

§Errors

Returns an error if the key is empty or the value is not non-empty text.

Source

pub fn ends_with( key: impl Into<String>, value: FilterValue, ) -> Result<Self, FilterError>

Matches text tags ending with value.

§Errors

Returns an error if the key is empty or the value is not non-empty text.

Source

pub fn contains( key: impl Into<String>, value: FilterValue, ) -> Result<Self, FilterError>

Matches text tags containing value.

§Errors

Returns an error if the key is empty or the value is not non-empty text.

Source

pub fn greater_than( key: impl Into<String>, value: FilterValue, ) -> Result<Self, FilterError>

Matches numeric tags greater than value.

§Errors

Returns an error if the key is empty or the value is not numeric.

Source

pub fn greater_than_or_equal( key: impl Into<String>, value: FilterValue, ) -> Result<Self, FilterError>

Matches numeric tags greater than or equal to value.

§Errors

Returns an error if the key is empty or the value is not numeric.

Source

pub fn less_than( key: impl Into<String>, value: FilterValue, ) -> Result<Self, FilterError>

Matches numeric tags less than value.

§Errors

Returns an error if the key is empty or the value is not numeric.

Source

pub fn less_than_or_equal( key: impl Into<String>, value: FilterValue, ) -> Result<Self, FilterError>

Matches numeric tags less than or equal to value.

§Errors

Returns an error if the key is empty or the value is not numeric.

Source

pub fn and<I>(filters: I) -> Result<Self, FilterError>
where I: IntoIterator<Item = Self>,

Requires every child expression to match.

§Errors

Returns an error if no child expressions are provided.

Source

pub fn or<I>(filters: I) -> Result<Self, FilterError>
where I: IntoIterator<Item = Self>,

Requires at least one child expression to match.

§Errors

Returns an error if no child expressions are provided.

Source

pub fn negate(filter: Self) -> Self

Negates filter.

Source

fn comparison( key: impl Into<String>, comparison: Comparison, ) -> Result<Self, FilterError>

Source

fn value_comparison( key: impl Into<String>, value: FilterValue, comparison: &'static str, required_kind: Option<&'static str>, constructor: impl FnOnce(FilterValue) -> Comparison, ) -> Result<Self, FilterError>

Source

fn list_comparison<I>( key: impl Into<String>, values: I, comparison: &'static str, constructor: impl FnOnce(Vec<FilterValue>) -> Comparison, ) -> Result<Self, FilterError>
where I: IntoIterator<Item = FilterValue>,

Source

fn group<I>( filters: I, operator: &'static str, constructor: impl FnOnce(Vec<Self>) -> FilterExpression, ) -> Result<Self, FilterError>
where I: IntoIterator<Item = Self>,

Source

fn precedence(&self) -> u8

Source

fn fmt_with_precedence( &self, formatter: &mut Formatter<'_>, parent_precedence: u8, ) -> Result

Trait Implementations§

Source§

impl Clone for SubscriptionFilter

Source§

fn clone(&self) -> SubscriptionFilter

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SubscriptionFilter

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for SubscriptionFilter

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<&SubscriptionFilter> for FilterNode

Source§

fn from(filter: &SubscriptionFilter) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for SubscriptionFilter

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Eq for SubscriptionFilter

Source§

impl StructuralPartialEq for SubscriptionFilter

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

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
Source§

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

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.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> SpecConfig for T
where T: Any + Debug + Send,

Source§

fn as_any(&self) -> &(dyn Any + 'static)

§

impl<T> ToCompactString for T
where T: Display,

§

fn try_to_compact_string(&self) -> Result<CompactString, ToCompactStringError>

Fallible version of [ToCompactString::to_compact_string()] Read more
§

fn to_compact_string(&self) -> CompactString

Converts the given value to a [CompactString]. Read more
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
§

impl<T> ToStringFallible for T
where T: Display,

§

fn try_to_string(&self) -> Result<String, TryReserveError>

ToString::to_string, but without panic on OOM.

Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more
§

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
Source§

impl<T> ResolverSyncBound for T
where T: Sync + ?Sized,