Skip to main content

FilterRegistry

Struct FilterRegistry 

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

Registry of available filter types.

use praxis_filter::FilterRegistry;

let registry = FilterRegistry::with_builtins();
let mut names = registry.available_filters();
names.sort();
assert!(names.contains(&"load_balancer"));
assert!(names.contains(&"request_id"));
assert!(names.contains(&"router"));

Implementations§

Source§

impl FilterRegistry

Source

pub fn with_builtins() -> Self

Create a registry with only the built-in filters.

Source

pub fn register( &mut self, name: &str, factory: FilterFactory, ) -> Result<(), FilterError>

Register a custom filter factory.

Returns an error if a filter with the same name is already registered.

use praxis_filter::{FilterFactory, FilterRegistry, http_builtin};

let mut registry = FilterRegistry::with_builtins();
let err = registry
    .register(
        "router",
        FilterFactory::Http(std::sync::Arc::new(|_| Err("unused".into()))),
    )
    .unwrap_err();
assert!(err.to_string().contains("duplicate filter name"));
§Errors

Returns FilterError if the name is already registered.

Source

pub fn create( &self, name: &str, config: &Value, ) -> Result<AnyFilter, FilterError>

Instantiate a filter by type name and config.

use praxis_filter::FilterRegistry;

let registry = FilterRegistry::with_builtins();
let filter = registry.create("router", &serde_yaml::from_str("routes: []").unwrap());
assert!(filter.is_ok());

let err = registry
    .create("nonexistent", &serde_yaml::Value::Null)
    .err()
    .expect("should fail for unknown type");
assert!(err.to_string().contains("unknown filter type"));
§Errors

Returns FilterError if the filter type is unknown or instantiation fails.

Source

pub fn available_filters(&self) -> Vec<&str>

Returns the names of all registered filter types.

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> 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, 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