Struct quilkin::filters::FilterChain

pub struct FilterChain { /* private fields */ }

A chain of Filters to be executed in order.

Executes each filter, passing the ReadContext and WriteContext between each filter’s execution, returning the result of data that has gone through all of the filters in the chain. If any of the filters in the chain return None, then the chain is broken, and None is returned.

Implementations

impl FilterChain

pub fn new( filters: Vec<(String, FilterInstance)> ) -> Result<Self, CreationError>

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn iter(&self) -> impl Iterator<Item = Filter> + '_

pub fn try_create_fallible<Item>( filter_configs: impl IntoIterator<Item = Item> ) -> Result<Self, CreationError>

where Item: TryInto<FilterConfig, Error = CreationError>,

Validates the filter configurations in the provided config and constructs a FilterChain if all configurations are valid, including the conversion into a Filter

pub fn try_create( filter_configs: impl IntoIterator<Item = FilterConfig> ) -> Result<Self, CreationError>

Validates the filter configurations in the provided config and constructs a FilterChain if all configurations are valid.

Trait Implementations

impl Clone for FilterChain

fn clone(&self) -> FilterChain

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FilterChain

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

Formats the value using the given formatter.

impl Default for FilterChain

fn default() -> FilterChain

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FilterChain

fn deserialize<D: Deserializer<'de>>(de: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Filter for FilterChain

fn read<'life0, 'life1, 'async_trait>( &'life0 self, ctx: &'life1 mut ReadContext ) -> Pin<Box<dyn Future<Output = Result<(), FilterError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Filter::read is invoked when the proxy receives data from a downstream connection on the listening port.

fn write<'life0, 'life1, 'async_trait>( &'life0 self, ctx: &'life1 mut WriteContext ) -> Pin<Box<dyn Future<Output = Result<(), FilterError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Filter::write is invoked when the proxy is about to send data to a downstream connection via the listening port after receiving it via one of the upstream Endpoints.

impl Index<usize> for FilterChain

type Output = (String, FilterInstance)

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl JsonSchema for FilterChain

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

impl PartialEq for FilterChain

fn eq(&self, rhs: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for FilterChain

fn serialize<S: Serializer>(&self, ser: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl TryFrom<&FilterChain> for FilterChain

type Error = CreationError

The type returned in the event of a conversion error.

fn try_from(chain: &FilterChain) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&FilterChain> for FilterChain

type Error = CreationError

The type returned in the event of a conversion error.

fn try_from(value: &FilterChain) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<FilterChain> for FilterChain

type Error = CreationError

The type returned in the event of a conversion error.

fn try_from(chain: FilterChain) -> Result<Self, Self::Error>

Performs the conversion.