Skip to main content

FilterResultSet

Struct FilterResultSet 

Source
pub struct FilterResultSet { /* private fields */ }
Expand description

Result feedback from a single filter execution.

Filters populate this to communicate outcomes (e.g. cache hit/miss, auth success/failure) without knowing about branching.

use praxis_filter::FilterResultSet;

let mut results = FilterResultSet::new();
results.set("status", "hit").unwrap();
assert_eq!(results.get("status"), Some("hit"));
assert!(results.matches("status", "hit"));
assert!(!results.matches("status", "miss"));

Implementations§

Source§

impl FilterResultSet

Source

pub fn new() -> Self

Create an empty result set.

use praxis_filter::FilterResultSet;

let rs = FilterResultSet::new();
assert!(rs.is_empty());
Source

pub fn get(&self, key: &str) -> Option<&str>

Get a result value by key.

use praxis_filter::FilterResultSet;

let mut rs = FilterResultSet::new();
rs.set("action", "allow").unwrap();
assert_eq!(rs.get("action"), Some("allow"));
assert_eq!(rs.get("missing"), None);
Source

pub fn is_empty(&self) -> bool

Whether the result set has no entries.

Source

pub fn matches(&self, key: &str, value: &str) -> bool

Whether a key-value pair matches.

use praxis_filter::FilterResultSet;

let mut rs = FilterResultSet::new();
rs.set("tier", "premium").unwrap();
assert!(rs.matches("tier", "premium"));
assert!(!rs.matches("tier", "free"));
assert!(!rs.matches("missing", "x"));
Source

pub fn set( &mut self, key: impl Into<Cow<'static, str>>, value: impl Into<Cow<'static, str>>, ) -> Result<(), FilterError>

Set a result key-value pair.

§Errors

Returns FilterError if:

  • key is empty, exceeds 64 bytes, or contains non-ASCII-alphanumeric characters (besides _ and -)
  • value exceeds 256 bytes or contains control characters (0x00-0x1F except 0x09/tab)
use praxis_filter::FilterResultSet;

let mut rs = FilterResultSet::new();
assert!(rs.set("valid-key_1", "value").is_ok());
assert!(rs.set("", "value").is_err());

Trait Implementations§

Source§

impl Clone for FilterResultSet

Source§

fn clone(&self) -> FilterResultSet

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FilterResultSet

Source§

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

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

impl Default for FilterResultSet

Source§

fn default() -> FilterResultSet

Returns the “default value” for a type. Read more

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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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, 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more