Skip to main content

ServiceEndpoint

Struct ServiceEndpoint 

pub struct ServiceEndpoint { /* private fields */ }
Available on crate features http and icap only.
Expand description

Configuration for one ICAP adaptation service URI.

Implementations§

§

impl ServiceEndpoint

pub fn new( uri: impl IntoUriInput, ) -> Result<ServiceEndpoint, ServiceEndpointError>

Parse an absolute ICAP service URI and derive its connector target.

pub const fn uri(&self) -> &Uri

Return the absolute ICAP service URI.

pub const fn authority(&self) -> &HostWithPort

Return the ICAP server transport target.

pub const fn headers(&self) -> &HeaderMap

Return additional ICAP request headers.

pub fn headers_mut(&mut self) -> &mut HeaderMap

Return mutable additional ICAP request headers.

Taking mutable access isolates subsequent OPTIONS cache entries from cloned endpoint configurations.

pub fn with_options_cache_partition( self, partition: OptionsCachePartition, ) -> ServiceEndpoint

Set the explicit OPTIONS cache identity for this endpoint.

Use distinct partitions when the same URI can return different capabilities for different credentials or connector policy.

pub fn set_options_cache_partition( &mut self, partition: OptionsCachePartition, ) -> &mut ServiceEndpoint

Set the explicit OPTIONS cache identity for this endpoint.

Use distinct partitions when the same URI can return different capabilities for different credentials or connector policy.

pub const fn options_cache_partition(&self) -> &OptionsCachePartition

Return the OPTIONS cache identity for this endpoint.

pub fn connection_extension<T>(&self) -> Option<&T>
where T: Extension,

Return the latest connection extension of type T.

pub fn insert_connection_extension<T>(&mut self, value: T) -> &T
where T: Extension,

Insert a connection extension applied to later ICAP connections.

Inserting isolates later OPTIONS discovery from clones of the previous endpoint configuration.

pub fn insert_connection_extension_arc<T>(&mut self, value: Arc<T>) -> Arc<T>
where T: Extension,

Insert a shared connection extension.

Inserting isolates later OPTIONS discovery from clones of the previous endpoint configuration.

pub fn maybe_with_preview(self, preview: Option<Preview>) -> ServiceEndpoint

Set the Preview limit used for entity-bearing messages.

pub fn maybe_set_preview( &mut self, preview: Option<Preview>, ) -> &mut ServiceEndpoint

Set the Preview limit used for entity-bearing messages.

pub fn with_preview(self, preview: Preview) -> ServiceEndpoint

Set the Preview limit used for entity-bearing messages.

pub fn set_preview(&mut self, preview: Preview) -> &mut ServiceEndpoint

Set the Preview limit used for entity-bearing messages.

pub fn without_preview(self) -> ServiceEndpoint

Set the Preview limit used for entity-bearing messages.

pub fn unset_preview(&mut self) -> &mut ServiceEndpoint

Set the Preview limit used for entity-bearing messages.

pub const fn preview(&self) -> Option<Preview>

Return the configured Preview limit.

pub fn with_allow_204(self, allow: bool) -> ServiceEndpoint

Set whether to advertise support for 204 outside Preview.

This requires retaining the complete original entity stream until the ICAP decision, so prefer Preview for large or unbounded bodies.

pub fn set_allow_204(&mut self, allow: bool) -> &mut ServiceEndpoint

Set whether to advertise support for 204 outside Preview.

This requires retaining the complete original entity stream until the ICAP decision, so prefer Preview for large or unbounded bodies.

pub const fn allows_204(&self) -> bool

Return whether 204 is advertised outside Preview.

pub fn with_allow_206(self, allow: bool) -> ServiceEndpoint

Set whether to advertise support for the 206 extension.

Without OPTIONS discovery, enabling this is an explicit out-of-band trust decision. The partial-content draft recommends advertising 206 only after the service confirms it through OPTIONS.

pub fn set_allow_206(&mut self, allow: bool) -> &mut ServiceEndpoint

Set whether to advertise support for the 206 extension.

Without OPTIONS discovery, enabling this is an explicit out-of-band trust decision. The partial-content draft recommends advertising 206 only after the service confirms it through OPTIONS.

pub const fn allows_206(&self) -> bool

Return whether the 206 extension is advertised.

pub fn with_allow_icap_trailers(self, allow: bool) -> ServiceEndpoint

Set whether requests offer negotiated outer ICAP response trailers.

The HTTP adaptation layer consumes these fields as ICAP metadata and never exposes them as HTTP trailers. The default is false.

pub fn set_allow_icap_trailers(&mut self, allow: bool) -> &mut ServiceEndpoint

Set whether requests offer negotiated outer ICAP response trailers.

The HTTP adaptation layer consumes these fields as ICAP metadata and never exposes them as HTTP trailers. The default is false.

pub const fn allows_icap_trailers(&self) -> bool

Return whether outer ICAP response trailers are offered.

pub const fn with_replay_limits(self, limits: ReplayLimits) -> ServiceEndpoint

Set the in-memory bounds for original HTTP replay frames.

pub fn set_replay_limits( &mut self, limits: ReplayLimits, ) -> &mut ServiceEndpoint

Set the in-memory bounds for original HTTP replay frames.

pub const fn replay_limits(&self) -> ReplayLimits

Return the original HTTP replay bounds.

pub fn options_request( &self, ) -> Result<OptionsRequest, ServiceEndpointRequestError>

Build a standalone capability-discovery request for this service.

Trait Implementations§

§

impl Clone for ServiceEndpoint

§

fn clone(&self) -> ServiceEndpoint

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 Debug for ServiceEndpoint

§

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

Formats the value using the given formatter. 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
§

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>

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
§

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,

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.

§

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

Source§

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

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,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = !

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

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