Skip to main content

ProxyDBLayer

Struct ProxyDBLayer

pub struct ProxyDBLayer<D, P, F> { /* private fields */ }

Available on crate feature proxy only.

Expand description

A Layer which wraps an inner Service to resolve proxy candidates based on the input extensions and publish route-specific proxy metadata.

See the crate docs for examples and more info on the usage of this service.

Implementations§

impl<D> ProxyDBLayer<D, bool, ()>

pub const fn new(db: D) -> ProxyDBLayer<D, bool, ()>

Create a new ProxyDBLayer with the given ProxyDB.

impl<D, P, F> ProxyDBLayer<D, P, F>

pub fn maybe_with_max_proxies( self, max_proxies: Option<NonZero<usize>>, ) -> ProxyDBLayer<D, P, F>

Limit the number of proxy candidates published for one query.

The default is DEFAULT_PROXY_DB_MAX_PROXIES. Use Self::without_max_proxies for an unbounded query.

pub fn maybe_set_max_proxies( &mut self, max_proxies: Option<NonZero<usize>>, ) -> &mut ProxyDBLayer<D, P, F>

Limit the number of proxy candidates published for one query.

The default is DEFAULT_PROXY_DB_MAX_PROXIES. Use Self::without_max_proxies for an unbounded query.

pub fn with_max_proxies( self, max_proxies: NonZero<usize>, ) -> ProxyDBLayer<D, P, F>

Limit the number of proxy candidates published for one query.

The default is DEFAULT_PROXY_DB_MAX_PROXIES. Use Self::without_max_proxies for an unbounded query.

pub fn set_max_proxies( &mut self, max_proxies: NonZero<usize>, ) -> &mut ProxyDBLayer<D, P, F>

Limit the number of proxy candidates published for one query.

The default is DEFAULT_PROXY_DB_MAX_PROXIES. Use Self::without_max_proxies for an unbounded query.

pub fn without_max_proxies(self) -> ProxyDBLayer<D, P, F>

Limit the number of proxy candidates published for one query.

The default is DEFAULT_PROXY_DB_MAX_PROXIES. Use Self::without_max_proxies for an unbounded query.

pub fn unset_max_proxies(&mut self) -> &mut ProxyDBLayer<D, P, F>

Limit the number of proxy candidates published for one query.

The default is DEFAULT_PROXY_DB_MAX_PROXIES. Use Self::without_max_proxies for an unbounded query.

pub fn with_filter_mode(self, mode: ProxyFilterMode) -> ProxyDBLayer<D, P, F>

Set a ProxyFilterMode to define the behaviour surrounding ProxyFilter usage, e.g. if a proxy filter is required to be available or not, or what to do if it is optional and not available.

pub fn set_filter_mode( &mut self, mode: ProxyFilterMode, ) -> &mut ProxyDBLayer<D, P, F>

Set a ProxyFilterMode to define the behaviour surrounding ProxyFilter usage, e.g. if a proxy filter is required to be available or not, or what to do if it is optional and not available.

pub fn with_single_proxy(self, single_proxy: bool) -> ProxyDBLayer<D, P, F>

Select and insert only one proxy instead of publishing every match as an ordered route plan. This uses the database’s singular-selection semantics, preserves legacy pre-fallback behaviour, and is disabled by default.

pub fn set_single_proxy( &mut self, single_proxy: bool, ) -> &mut ProxyDBLayer<D, P, F>

Select and insert only one proxy instead of publishing every match as an ordered route plan. This uses the database’s singular-selection semantics, preserves legacy pre-fallback behaviour, and is disabled by default.

pub fn with_overwrite_proxy( self, overwrite_proxy: bool, ) -> ProxyDBLayer<D, P, F>

Overwrite an existing singular ProxyRoute with the selected proxy route or route plan. This is disabled by default in both plural and singular selection modes.

pub fn set_overwrite_proxy( &mut self, overwrite_proxy: bool, ) -> &mut ProxyDBLayer<D, P, F>

Overwrite an existing singular ProxyRoute with the selected proxy route or route plan. This is disabled by default in both plural and singular selection modes.

pub fn with_select_predicate<Predicate>( self, p: Predicate, ) -> ProxyDBLayer<D, Predicate, F>

Set a ProxyQueryPredicate that will be used to possibly filter out proxies that according to the filters are correct, but not according to the predicate.

pub fn with_username_formatter<Formatter>( self, f: Formatter, ) -> ProxyDBLayer<D, P, Formatter>

Set an optional UsernameFormatter for Basic-auth proxy usernames. It is called separately for each published candidate, so routing labels can depend on that proxy’s metadata. Bearer credentials and proxies without credentials are left unchanged.

Trait Implementations§

impl<D, P, F> Clone for ProxyDBLayer<D, P, F>
where D: Clone, P: Clone, F: Clone,

fn clone(&self) -> ProxyDBLayer<D, P, F>

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

impl<D, P, F> Debug for ProxyDBLayer<D, P, F>
where D: Debug, P: Debug, F: Debug,

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

Formats the value using the given formatter. Read more

impl<S, D, P, F> Layer<S> for ProxyDBLayer<D, P, F>
where D: Clone, P: Clone, F: Clone,

type Service = ProxyDBService<S, D, P, F>

The service produced by the layer.

fn layer(&self, inner: S) -> <ProxyDBLayer<D, P, F> as Layer<S>>::Service

Wrap the given service with the middleware, returning a new service.

fn into_layer(self, inner: S) -> <ProxyDBLayer<D, P, F> as Layer<S>>::Service

Same as layer but consuming self after the service was created. Read more

Auto Trait Implementations§

impl<D, P, F> Freeze for ProxyDBLayer<D, P, F>
where D: Freeze, P: Freeze, F: Freeze,

impl<D, P, F> RefUnwindSafe for ProxyDBLayer<D, P, F>
where D: RefUnwindSafe, P: RefUnwindSafe, F: RefUnwindSafe,

impl<D, P, F> Send for ProxyDBLayer<D, P, F>
where D: Send, P: Send, F: Send,

impl<D, P, F> Sync for ProxyDBLayer<D, P, F>
where D: Sync, P: Sync, F: Sync,

impl<D, P, F> Unpin for ProxyDBLayer<D, P, F>
where D: Unpin, P: Unpin, F: Unpin,

impl<D, P, F> UnsafeUnpin for ProxyDBLayer<D, P, F>
where D: UnsafeUnpin, P: UnsafeUnpin, F: UnsafeUnpin,

impl<D, P, F> UnwindSafe for ProxyDBLayer<D, P, F>
where D: UnwindSafe, P: UnwindSafe, F: UnwindSafe,

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

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

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

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

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

impl<T> FutureExt for T

fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ

Attaches the provided Context to this type, returning a WithContext wrapper. Read more

fn with_current_context(self) -> WithContext<Self> ⓘ

Attaches the current Context to this type, returning a WithContext wrapper. Read more

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

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

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

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

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

fn into_request(self) -> Request<T>

Wrap the input message T in a rama_grpc::Request

impl<L> LayerExt<L> for L

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.

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: Sized + 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: Sized + 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

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

fn rama_from(value: T) -> U

impl<T, U, CrateMarker> RamaInto<U, CrateMarker> for T
where U: RamaFrom<T, CrateMarker>,

fn rama_into(self) -> U

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

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

fn rama_try_from(value: T) -> Result<U, <U as RamaTryFrom<T>>::Error>

impl<T, U, CrateMarker> RamaTryInto<U, CrateMarker> for T
where U: RamaTryFrom<T, CrateMarker>,

type Error = <U as RamaTryFrom<T, CrateMarker>>::Error

fn rama_try_into(self) -> Result<U, <U as RamaTryFrom<T, CrateMarker>>::Error>

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

impl<T> Same for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<V, F> ValueFormatter<&V> for F
where F: ValueFormatter<V> + ?Sized, V: ?Sized,

const SHAPE: FieldShape<'static>

Available on non-metrique_require_explicit_impls only.

The shape of values produced by this formatter. Read more

fn format_value(writer: impl ValueWriter, value: &&V)

Write value to writer

impl<V, F> ValueFormatter<Arc<V>> for F
where F: ValueFormatter<V> + ?Sized, V: ?Sized,

const SHAPE: FieldShape<'static>

Available on non-metrique_require_explicit_impls only.

The shape of values produced by this formatter. Read more

fn format_value(writer: impl ValueWriter, value: &Arc<V>)

Write value to writer

impl<V, F> ValueFormatter<Box<V>> for F
where F: ValueFormatter<V> + ?Sized, V: ?Sized,

const SHAPE: FieldShape<'static>

Available on non-metrique_require_explicit_impls only.

The shape of values produced by this formatter. Read more

fn format_value(writer: impl ValueWriter, value: &Box<V>)

Write value to writer

impl<V, F> ValueFormatter<Cow<'_, V>> for F
where V: ToOwned + ?Sized, F: ValueFormatter<V> + ?Sized,

const SHAPE: FieldShape<'static>

Available on non-metrique_require_explicit_impls only.

The shape of values produced by this formatter. Read more

fn format_value(writer: impl ValueWriter, value: &Cow<'_, V>)

Write value to writer

impl<V, F> ValueFormatter<Option<V>> for F
where F: ValueFormatter<V> + ?Sized,

const SHAPE: FieldShape<'static>

Available on non-metrique_require_explicit_impls only.

The shape of values produced by this formatter. Read more

fn format_value(writer: impl ValueWriter, value: &Option<V>)

Write value to writer

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