Struct hvcg_iam_openapi_identity::client::Client [−][src]
pub struct Client<S, C> where
S: Service<(Request<Body>, C), Response = Response<Body>> + Clone + Sync + Send + 'static,
S::Future: Send + 'static,
S::Error: Into<Box<dyn Error + Send + Sync + 'static>> + Display,
C: Clone + Send + Sync + 'static, { /* fields omitted */ }
Expand description
A client that implements the API by making HTTP calls out to a server.
Implementations
pub fn try_new_with_connector(
base_path: &str,
protocol: Option<&'static str>,
connector: Connector
) -> Result<Self, ClientInitError>
pub fn try_new_with_connector(
base_path: &str,
protocol: Option<&'static str>,
connector: Connector
) -> Result<Self, ClientInitError>
Create a client with a custom implementation of hyper::client::Connect.
Intended for use with custom implementations of connect for e.g. protocol logging
or similar functionality which requires wrapping the transport layer. When wrapping a TCP connection,
this function should be used in conjunction with swagger::Connector::builder()
.
For ordinary tcp connections, prefer the use of try_new_http
, try_new_https
and try_new_https_mutual
, to avoid introducing a dependency on the underlying transport layer.
Arguments
base_path
- base path of the client API, i.e. “http://www.my-api-implementation.com”protocol
- Which protocol to use when constructing the request url, e.g.Some("http")
connector
- Implementation ofhyper::client::Connect
to use for the client
impl<C> Client<DropContextService<Client<HttpConnector, Body>, C>, C> where
C: Clone + Send + Sync + 'static,
impl<C> Client<DropContextService<Client<HttpConnector, Body>, C>, C> where
C: Clone + Send + Sync + 'static,
Create an HTTP client.
Arguments
base_path
- base path of the client API, i.e. “http://www.my-api-implementation.com”
impl<C> Client<DropContextService<Client<HttpsConnector<HttpConnector>, Body>, C>, C> where
C: Clone + Send + Sync + 'static,
impl<C> Client<DropContextService<Client<HttpsConnector<HttpConnector>, Body>, C>, C> where
C: Clone + Send + Sync + 'static,
Create a client with a TLS connection to the server
Arguments
base_path
- base path of the client API, i.e. “https://www.my-api-implementation.com”
pub fn try_new_https_pinned<CA>(
base_path: &str,
ca_certificate: CA
) -> Result<Self, ClientInitError> where
CA: AsRef<Path>,
pub fn try_new_https_pinned<CA>(
base_path: &str,
ca_certificate: CA
) -> Result<Self, ClientInitError> where
CA: AsRef<Path>,
Create a client with a TLS connection to the server using a pinned certificate
Arguments
base_path
- base path of the client API, i.e. “https://www.my-api-implementation.com”ca_certificate
- Path to CA certificate used to authenticate the server
Create a client with a mutually authenticated TLS connection to the server.
Arguments
base_path
- base path of the client API, i.e. “https://www.my-api-implementation.com”ca_certificate
- Path to CA certificate used to authenticate the serverclient_key
- Path to the client private keyclient_certificate
- Path to the client’s public certificate associated with the private key
pub fn try_new_with_client_service(
client_service: S,
base_path: &str
) -> Result<Self, ClientInitError>
pub fn try_new_with_client_service(
client_service: S,
base_path: &str
) -> Result<Self, ClientInitError>
Constructor for creating a Client
by passing in a pre-made hyper::service::Service
/
tower::Service
This allows adding custom wrappers around the underlying transport, for example for logging.
Trait Implementations
impl<S, C> Api<C> for Client<S, C> where
S: Service<(Request<Body>, C), Response = Response<Body>> + Clone + Sync + Send + 'static,
S::Future: Send + 'static,
S::Error: Into<Box<dyn Error + Send + Sync + 'static>> + Display,
C: Has<XSpanIdString> + Has<Option<AuthData>> + Clone + Send + Sync + 'static,
impl<S, C> Api<C> for Client<S, C> where
S: Service<(Request<Body>, C), Response = Response<Body>> + Clone + Sync + Send + 'static,
S::Future: Send + 'static,
S::Error: Into<Box<dyn Error + Send + Sync + 'static>> + Display,
C: Has<XSpanIdString> + Has<Option<AuthData>> + Clone + Send + Sync + 'static,
fn poll_ready(
&self,
cx: &mut Context<'_>
) -> Poll<Result<(), Box<dyn Error + Send + Sync + 'static>>>
fn activate_user<'life0, 'life1, 'async_trait>(
&'life0 self,
context: &'life1 C
) -> Pin<Box<dyn Future<Output = Result<ActivateUserResponse, ApiError>> + Send + 'async_trait>> where
'life0: 'async_trait,
'life1: 'async_trait,
Self: 'async_trait,
fn activate_user<'life0, 'life1, 'async_trait>(
&'life0 self,
context: &'life1 C
) -> Pin<Box<dyn Future<Output = Result<ActivateUserResponse, ApiError>> + Send + 'async_trait>> where
'life0: 'async_trait,
'life1: 'async_trait,
Self: 'async_trait,
Activate a user
Create user
fn deactivate_user<'life0, 'life1, 'async_trait>(
&'life0 self,
context: &'life1 C
) -> Pin<Box<dyn Future<Output = Result<DeactivateUserResponse, ApiError>> + Send + 'async_trait>> where
'life0: 'async_trait,
'life1: 'async_trait,
Self: 'async_trait,
fn deactivate_user<'life0, 'life1, 'async_trait>(
&'life0 self,
context: &'life1 C
) -> Pin<Box<dyn Future<Output = Result<DeactivateUserResponse, ApiError>> + Send + 'async_trait>> where
'life0: 'async_trait,
'life1: 'async_trait,
Self: 'async_trait,
Deactive user
fn update_password<'life0, 'life1, 'async_trait>(
&'life0 self,
param_inline_object: InlineObject,
context: &'life1 C
) -> Pin<Box<dyn Future<Output = Result<UpdatePasswordResponse, ApiError>> + Send + 'async_trait>> where
'life0: 'async_trait,
'life1: 'async_trait,
Self: 'async_trait,
fn update_password<'life0, 'life1, 'async_trait>(
&'life0 self,
param_inline_object: InlineObject,
context: &'life1 C
) -> Pin<Box<dyn Future<Output = Result<UpdatePasswordResponse, ApiError>> + Send + 'async_trait>> where
'life0: 'async_trait,
'life1: 'async_trait,
Self: 'async_trait,
update password
Get user infomation by id
fn query_users<'life0, 'life1, 'async_trait>(
&'life0 self,
param_username: Option<String>,
param_phone: Option<String>,
context: &'life1 C
) -> Pin<Box<dyn Future<Output = Result<QueryUsersResponse, ApiError>> + Send + 'async_trait>> where
'life0: 'async_trait,
'life1: 'async_trait,
Self: 'async_trait,
fn query_users<'life0, 'life1, 'async_trait>(
&'life0 self,
param_username: Option<String>,
param_phone: Option<String>,
context: &'life1 C
) -> Pin<Box<dyn Future<Output = Result<QueryUsersResponse, ApiError>> + Send + 'async_trait>> where
'life0: 'async_trait,
'life1: 'async_trait,
Self: 'async_trait,
Get users infomation
Auto Trait Implementations
impl<S, C> RefUnwindSafe for Client<S, C> where
S: RefUnwindSafe,
impl<S, C> UnwindSafe for Client<S, C> where
S: UnwindSafe,
Blanket Implementations
Mutably borrows from an owned value. Read more
Binds this API to a context.
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more