Struct Client
pub struct Client<S> { /* private fields */ }Available on crate features
icap and std only.Expand description
Wraps an inner connector and produces ICAP client connections.
The inner stack establishes the transport and can include proxy, TLS, or mTLS layers. Input and connection extensions are preserved.
§Pooling contract
Pool raw transports inside Client. Do not wrap Client in a
transport pool: its ICAP connection remains leased until response framing
completes.
Do not leave drop_connection_if_no_response enabled on the inner
pool. ICAP reports unusable transports through Rama’s shared health
watcher.
Implementations§
§impl<S> Client<S>
impl<S> Client<S>
pub const fn with_options(self, options: ConnectionOptions) -> Client<S>
pub const fn with_options(self, options: ConnectionOptions) -> Client<S>
Set the options used by each established ICAP connection.
pub fn set_options(&mut self, options: ConnectionOptions) -> &mut Client<S>
pub fn set_options(&mut self, options: ConnectionOptions) -> &mut Client<S>
Set the options used by each established ICAP connection.
pub const fn options(&self) -> &ConnectionOptions
pub const fn options(&self) -> &ConnectionOptions
Return the options used by new ICAP connections.
pub fn into_inner(self) -> S
pub fn into_inner(self) -> S
Consumes self, returning the underlying service.
pub async fn connect<Input>(
&self,
input: Input,
) -> Result<EstablishedClientConnection<ClientConnection<<S as ConnectorService<Input>>::Connection>, Input>, ConnectionError>where
S: ConnectorService<Input>,
<S as ConnectorService<Input>>::Connection: Io + Unpin + ExtensionsRef,
pub async fn connect<Input>(
&self,
input: Input,
) -> Result<EstablishedClientConnection<ClientConnection<<S as ConnectorService<Input>>::Connection>, Input>, ConnectionError>where
S: ConnectorService<Input>,
<S as ConnectorService<Input>>::Connection: Io + Unpin + ExtensionsRef,
Establish an ICAP connection with the inner connector stack.
Trait Implementations§
§impl<S, Input> Service<Input> for Client<S>where
S: ConnectorService<Input>,
<S as ConnectorService<Input>>::Connection: Io + Unpin + ExtensionsRef,
Input: Send + 'static,
impl<S, Input> Service<Input> for Client<S>where
S: ConnectorService<Input>,
<S as ConnectorService<Input>>::Connection: Io + Unpin + ExtensionsRef,
Input: Send + 'static,
§type Output = EstablishedClientConnection<ClientConnection<<S as ConnectorService<Input>>::Connection>, Input>
type Output = EstablishedClientConnection<ClientConnection<<S as ConnectorService<Input>>::Connection>, Input>
The type of the output returned by the service.
§type Error = ConnectionError
type Error = ConnectionError
The type of error returned by the service.
§async fn serve(
&self,
input: Input,
) -> Result<<Client<S> as Service<Input>>::Output, <Client<S> as Service<Input>>::Error>
async fn serve( &self, input: Input, ) -> Result<<Client<S> as Service<Input>>::Output, <Client<S> as Service<Input>>::Error>
Serve an output or an error for the given input
§fn boxed(self) -> BoxService<Input, Self::Output, Self::Error>
fn boxed(self) -> BoxService<Input, Self::Output, Self::Error>
Box this service to allow for dynamic dispatch.
Auto Trait Implementations§
impl<S> Freeze for Client<S>where
S: Freeze,
impl<S> RefUnwindSafe for Client<S>where
S: RefUnwindSafe,
impl<S> Send for Client<S>where
S: Send,
impl<S> Sync for Client<S>where
S: Sync,
impl<S> Unpin for Client<S>where
S: Unpin,
impl<S> UnsafeUnpin for Client<S>where
S: UnsafeUnpin,
impl<S> UnwindSafe for Client<S>where
S: UnwindSafe,
Blanket Implementations§
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<S, Input, Connection> ConnectorService<Input> for Swhere
S: Service<Input, Output = EstablishedClientConnection<Connection, Input>>,
<S as Service<Input>>::Error: Into<ConnectionError>,
Connection: Send + ExtensionsRef,
impl<S, Input, Connection> ConnectorService<Input> for Swhere
S: Service<Input, Output = EstablishedClientConnection<Connection, Input>>,
<S as Service<Input>>::Error: Into<ConnectionError>,
Connection: Send + ExtensionsRef,
§type Connection = Connection
type Connection = Connection
Connection returned by the
ConnectorService§fn connect(
&self,
input: Input,
) -> impl Future<Output = Result<EstablishedClientConnection<<S as ConnectorService<Input>>::Connection, Input>, ConnectionError>> + Send
fn connect( &self, input: Input, ) -> impl Future<Output = Result<EstablishedClientConnection<<S as ConnectorService<Input>>::Connection, Input>, ConnectionError>> + Send
Establish a connection, which often involves some kind of handshake,
or connection revival. Read more
§impl<T> FutureExt for T
impl<T> FutureExt for T
§fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ
fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ
§fn with_current_context(self) -> WithContext<Self> ⓘ
fn with_current_context(self) -> WithContext<Self> ⓘ
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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<S> IntoEndpointService<(S,)> for S
impl<S> IntoEndpointService<(S,)> for S
type Service = S
§fn into_endpoint_service(self) -> <S as IntoEndpointService<(S,)>>::Service
fn into_endpoint_service(self) -> <S as IntoEndpointService<(S,)>>::Service
convert the type into a
rama_core::Service.§impl<S, State> IntoEndpointServiceWithState<(S,), State> for S
impl<S, State> IntoEndpointServiceWithState<(S,), State> for S
type Service = S
§fn into_endpoint_service_with_state(
self,
_state: State,
) -> <S as IntoEndpointServiceWithState<(S,), State>>::Service
fn into_endpoint_service_with_state( self, _state: State, ) -> <S as IntoEndpointServiceWithState<(S,), State>>::Service
convert the type into a
rama_core::Service with state.§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
Wrap the input message
T in a rama_grpc::Request§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
§fn and<P, B, E>(self, other: P) -> And<T, P>
fn and<P, B, E>(self, other: P) -> And<T, P>
Create a new
Policy that returns Action::Follow only if self and other return
Action::Follow. Read more§impl<T, U> RamaTryFrom<T> for Uwhere
U: TryFrom<T>,
impl<T, U> RamaTryFrom<T> for Uwhere
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 Twhere
U: RamaTryFrom<T, CrateMarker>,
impl<T, U, CrateMarker> RamaTryInto<U, CrateMarker> for Twhere
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 Twhere
T: ?Sized,
§impl<S, Socket> SocketService for S
impl<S, Socket> SocketService for S
§type Socket = Socket
type Socket = Socket
Socket returned by the
SocketService§type Error = <S as Service<SocketAddress>>::Error
type Error = <S as Service<SocketAddress>>::Error
Error returned in case of connection / setup failure
§fn bind_socket_with_address(
&self,
addr: impl Into<SocketAddress>,
) -> impl Future<Output = Result<<S as SocketService>::Socket, <S as SocketService>::Error>> + Send
fn bind_socket_with_address( &self, addr: impl Into<SocketAddress>, ) -> impl Future<Output = Result<<S as SocketService>::Socket, <S as SocketService>::Error>> + Send
Create a binding to a Unix/Linux/Windows socket.