Enum Predicate 

pub enum Predicate<In = Request<Bytes>, Err = ProximaError> {
    Always {
        _marker: PhantomData<fn(In) -> Err>,
    },
    Never {
        _marker: PhantomData<fn(In) -> Err>,
    },
    When {
        gate: When,
        calls: Arc<AtomicU64>,
        _marker: PhantomData<fn(In) -> Err>,
    },
    Unless {
        gate: When,
        calls: Arc<AtomicU64>,
        _marker: PhantomData<fn(In) -> Err>,
    },
}

The config-expressible predicate set, generic over the payload In it passes through unchanged on admit and the Err it rejects with. Implements SendPipe/Pipe directly (In -> Result<In, Err>): Ok(input) on admit, Err::forbidden() on reject — the same payload FilterConfig’s RejectMode::Drop produces, since drop was always this crate’s default reject mode (FilterConfig::default). Defaults to the crate’s own HTTP types (Request<Bytes>, ProximaError) so a caller instantiates Predicate::<MyIn, MyErr> to gate their own payload without minting a type and without touching this one.

Variants

Always

Fields

_marker: PhantomData<fn(In) -> Err>

Never

Fields

_marker: PhantomData<fn(In) -> Err>

When

Fields

gate: When

calls: Arc<AtomicU64>

_marker: PhantomData<fn(In) -> Err>

Unless

Fields

gate: When

calls: Arc<AtomicU64>

_marker: PhantomData<fn(In) -> Err>

Implementations

impl<In, Err> Predicate<In, Err>

pub fn always() -> Self

pub fn never() -> Self

pub fn when(gate: When) -> Self

pub fn unless(gate: When) -> Self

Trait Implementations

impl<In, Err> Clone for Predicate<In, Err>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<In, Err> Debug for Predicate<In, Err>

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

Formats the value using the given formatter.

impl<'de, In, Err> Deserialize<'de> for Predicate<In, Err>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<In, Err> PartialEq for Predicate<In, Err>

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

Equality operator ==.

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

Inequality operator !=.

impl<In, Err> Pipe for Predicate<In, Err>

where In: 'static, Err: From<RejectMode> + Debug + 'static,

type In = In

Input the pipe consumes.

type Out = In

Output the pipe produces.

type Err = Err

Error the pipe can fail with. Debug + 'static; Send is added only on the cross-core SendPipe form.

fn call(&self, input: In) -> impl Future<Output = Result<In, Err>>

Apply the pipe. The returned future is NOT required to be Send.

impl<In, Err> SendPipe for Predicate<In, Err>

where In: Send + 'static, Err: From<RejectMode> + Debug + Send + 'static,

type In = In

Input the pipe consumes.

type Out = In

Output the pipe produces.

type Err = Err

Error the pipe can fail with — Send here so it can cross cores.

fn call(&self, input: In) -> impl Future<Output = Result<In, Err>> + Send

Apply the pipe. The returned future IS Send.

impl<In, Err> Serialize for Predicate<In, Err>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<In, Err> UnpinPipe for Predicate<In, Err>

where In: 'static, Err: From<RejectMode> + Debug + 'static,

type In = In

Input the pipe consumes.

type Out = In

Output the pipe produces.

type Err = Err

Error the pipe can fail with.

fn call(&self, input: In) -> impl Future<Output = Result<In, Err>> + Unpin

Apply the pipe. The returned future IS Unpin — pollable in place.

impl<In, Err> UnpinSendPipe for Predicate<In, Err>

where In: Send + 'static, Err: From<RejectMode> + Debug + Send + 'static,

type In = In

Input the pipe consumes.

type Out = In

Output the pipe produces.

type Err = Err

Error the pipe can fail with — Send here so it can cross cores.

fn call( &self, input: In, ) -> impl Future<Output = Result<In, Err>> + Send + Unpin

Apply the pipe. The returned future is Send AND Unpin.