Struct hvcg_example_openapi_entity::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

impl<Connector, C> Client<DropContextService<Client<Connector, Body>, C>, C> where
    Connector: Connect + Clone + Send + Sync + 'static,
    C: Clone + Send + Sync + 'static, [src]

pub fn try_new_with_connector(
    base_path: &str,
    protocol: Option<&'static str>,
    connector: Connector
) -> Result<Self, ClientInitError>[src]

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 of hyper::client::Connect to use for the client

impl<C> Client<DropContextService<HyperClient, C>, C> where
    C: Clone + Send + Sync + 'static, [src]

pub fn try_new(base_path: &str) -> Result<Self, ClientInitError>[src]

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<HttpConnector, Body>, C>, C> where
    C: Clone + Send + Sync + 'static, [src]

pub fn try_new_http(base_path: &str) -> Result<Self, ClientInitError>[src]

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, [src]

pub fn try_new_https(base_path: &str) -> Result<Self, ClientInitError>[src]

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>, [src]

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

pub fn try_new_https_mutual<CA, K, D>(
    base_path: &str,
    ca_certificate: CA,
    client_key: K,
    client_certificate: D
) -> Result<Self, ClientInitError> where
    CA: AsRef<Path>,
    K: AsRef<Path>,
    D: AsRef<Path>, [src]

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 server
  • client_key - Path to the client private key
  • client_certificate - Path to the client’s public certificate associated with the private key

impl<S, C> 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, [src]

pub fn try_new_with_client_service(
    client_service: S,
    base_path: &str
) -> Result<Self, ClientInitError>[src]

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, [src]

fn poll_ready(
    &self,
    cx: &mut Context<'_>
) -> Poll<Result<(), Box<dyn Error + Send + Sync + 'static>>>[src]

fn add_pet<'life0, 'life1, 'async_trait>(
    &'life0 self,
    param_pet: Pet,
    context: &'life1 C
) -> Pin<Box<dyn Future<Output = Result<AddPetResponse, ApiError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, [src]

Add a new pet to the store

fn delete_pet<'life0, 'life1, 'async_trait>(
    &'life0 self,
    param_pet_id: i64,
    param_api_key: Option<String>,
    context: &'life1 C
) -> Pin<Box<dyn Future<Output = Result<DeletePetResponse, ApiError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, [src]

Deletes a pet

fn find_pets_by_status<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    param_status: &'life1 Vec<String>,
    context: &'life2 C
) -> Pin<Box<dyn Future<Output = Result<FindPetsByStatusResponse, ApiError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait, [src]

Finds Pets by status

fn find_pets_by_tags<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    param_tags: &'life1 Vec<String>,
    context: &'life2 C
) -> Pin<Box<dyn Future<Output = Result<FindPetsByTagsResponse, ApiError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait, [src]

Finds Pets by tags

fn get_pet_by_id<'life0, 'life1, 'async_trait>(
    &'life0 self,
    param_pet_id: i64,
    context: &'life1 C
) -> Pin<Box<dyn Future<Output = Result<GetPetByIdResponse, ApiError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, [src]

Find pet by ID

fn update_pet<'life0, 'life1, 'async_trait>(
    &'life0 self,
    param_pet: Pet,
    context: &'life1 C
) -> Pin<Box<dyn Future<Output = Result<UpdatePetResponse, ApiError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, [src]

Update an existing pet

fn update_pet_with_form<'life0, 'life1, 'async_trait>(
    &'life0 self,
    param_pet_id: i64,
    param_name: Option<String>,
    param_status: Option<String>,
    context: &'life1 C
) -> Pin<Box<dyn Future<Output = Result<UpdatePetWithFormResponse, ApiError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, [src]

Updates a pet in the store with form data

fn upload_file<'life0, 'life1, 'async_trait>(
    &'life0 self,
    param_pet_id: i64,
    param_additional_metadata: Option<String>,
    param_file: Option<ByteArray>,
    context: &'life1 C
) -> Pin<Box<dyn Future<Output = Result<UploadFileResponse, ApiError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, [src]

uploads an image

fn delete_order<'life0, 'life1, 'async_trait>(
    &'life0 self,
    param_order_id: String,
    context: &'life1 C
) -> Pin<Box<dyn Future<Output = Result<DeleteOrderResponse, ApiError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, [src]

Delete purchase order by ID

fn get_inventory<'life0, 'life1, 'async_trait>(
    &'life0 self,
    context: &'life1 C
) -> Pin<Box<dyn Future<Output = Result<GetInventoryResponse, ApiError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, [src]

Returns pet inventories by status

fn get_order_by_id<'life0, 'life1, 'async_trait>(
    &'life0 self,
    param_order_id: i64,
    context: &'life1 C
) -> Pin<Box<dyn Future<Output = Result<GetOrderByIdResponse, ApiError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, [src]

Find purchase order by ID

fn place_order<'life0, 'life1, 'async_trait>(
    &'life0 self,
    param_order: Order,
    context: &'life1 C
) -> Pin<Box<dyn Future<Output = Result<PlaceOrderResponse, ApiError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, [src]

Place an order for a pet

fn create_user<'life0, 'life1, 'async_trait>(
    &'life0 self,
    param_user: User,
    context: &'life1 C
) -> Pin<Box<dyn Future<Output = Result<CreateUserResponse, ApiError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, [src]

Create user

fn create_users_with_array_input<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    param_user: &'life1 Vec<User>,
    context: &'life2 C
) -> Pin<Box<dyn Future<Output = Result<CreateUsersWithArrayInputResponse, ApiError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait, [src]

Creates list of users with given input array

fn create_users_with_list_input<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    param_user: &'life1 Vec<User>,
    context: &'life2 C
) -> Pin<Box<dyn Future<Output = Result<CreateUsersWithListInputResponse, ApiError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait, [src]

Creates list of users with given input array

fn delete_user<'life0, 'life1, 'async_trait>(
    &'life0 self,
    param_username: String,
    context: &'life1 C
) -> Pin<Box<dyn Future<Output = Result<DeleteUserResponse, ApiError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, [src]

Delete user

fn get_user_by_name<'life0, 'life1, 'async_trait>(
    &'life0 self,
    param_username: String,
    context: &'life1 C
) -> Pin<Box<dyn Future<Output = Result<GetUserByNameResponse, ApiError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, [src]

Get user by user name

fn login_user<'life0, 'life1, 'async_trait>(
    &'life0 self,
    param_username: String,
    param_password: String,
    context: &'life1 C
) -> Pin<Box<dyn Future<Output = Result<LoginUserResponse, ApiError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, [src]

Logs user into the system

fn logout_user<'life0, 'life1, 'async_trait>(
    &'life0 self,
    context: &'life1 C
) -> Pin<Box<dyn Future<Output = Result<LogoutUserResponse, ApiError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, [src]

Logs out current logged in user session

fn update_user<'life0, 'life1, 'async_trait>(
    &'life0 self,
    param_username: String,
    param_user: User,
    context: &'life1 C
) -> Pin<Box<dyn Future<Output = Result<UpdateUserResponse, ApiError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, [src]

Updated user

impl<S, C> Clone 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: Clone + Send + Sync + 'static, [src]

fn clone(&self) -> Self[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl<S, C> Debug 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: Clone + Send + Sync + 'static, [src]

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl<S, C> RefUnwindSafe for Client<S, C> where
    S: RefUnwindSafe, 

impl<S, C> Send for Client<S, C>

impl<S, C> Sync for Client<S, C>

impl<S, C> Unpin for Client<S, C> where
    S: Unpin, 

impl<S, C> UnwindSafe for Client<S, C> where
    S: UnwindSafe, 

Blanket Implementations

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

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T, C> ContextWrapperExt<C> for T where
    C: Clone + Send + Sync,
    T: Api<C> + Send + Sync, [src]

pub fn with_context(Self, C) -> ContextWrapper<T, C>[src]

Binds this API to a context.

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T> Instrument for T[src]

fn instrument(self, span: Span) -> Instrumented<Self>[src]

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>[src]

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T> Instrument for T[src]

fn instrument(self, span: Span) -> Instrumented<Self>[src]

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>[src]

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

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

pub fn clone_into(&self, target: &mut T)[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

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

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

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

The type returned in the event of a conversion error.

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

Performs the conversion.

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

pub fn vzip(self) -> V