Struct ServiceEndpoint 

pub struct ServiceEndpoint { /* private fields */ }

Available on crate features http and icap only.

Configuration for one ICAP adaptation service URI.

Connection pools serving both icap and icaps endpoints must include the application Protocol in their connection identity. An authority alone does not distinguish plaintext from direct TLS when both schemes use the same explicit port.

An icaps endpoint requests direct TLS and defaults to port 11344. The connector supplied to the ICAP client must provide TLS support; the ICAP request target itself is normalized to the RFC-defined icap scheme. URI userinfo is part of that request target and is therefore sent on every exchange. Avoid putting credentials in the URI, especially over plaintext icap connections.

Implementations

impl ServiceEndpoint

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

Parse an absolute ICAP or direct-TLS ICAPS service URI.

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

Return the configured ICAP service identity.

Direct-TLS endpoints retain their icaps scheme here even though requests use the RFC icap scheme on the wire.

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

Return the logical ICAP service authority used for TLS identity and connection pooling.

A configured rama_net::client::ConnectorTarget remains a separate physical dial override in the connection extensions.

pub const fn service_protocol(&self) -> &Protocol

Return the configured ICAP application protocol.

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

fn authority(&self) -> Option<HostWithOptPort>

The routing authority (host[:port]), or None if none is resolvable.

fn host(&self) -> Option<Host>

The authority Host, dropping any port.

fn host_as_domain(&self) -> Option<Domain>

The authority host as a Domain, or None if absent or not a domain (e.g. an IP literal).

fn port(&self) -> Option<u16>

The authority port, if one is set explicitly.

fn authority_with_default_port( &self, fallback: Option<u16>, ) -> Option<HostWithPort>

where Self: ProtocolInputExt,

Resolve the logical authority with its explicit port, the application protocol’s default port, or finally fallback.

impl Clone for ServiceEndpoint

fn clone(&self) -> ServiceEndpoint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ServiceEndpoint

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

Formats the value using the given formatter.

impl ProtocolInputExt for ServiceEndpoint

fn protocol(&self) -> Option<&Protocol>

The application protocol, or None if it can’t be determined.

fn protocol_default_port(&self) -> Option<u16>

The default port of the resolved Protocol (e.g. 443 for HTTPS), or None if the protocol is unknown or portless.

impl UriInputExt for ServiceEndpoint

fn uri(&self) -> &Uri

The Uri this input carries.