aws_sdk_geoplaces/
client.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2#[derive(Debug)]
3pub(crate) struct Handle {
4    pub(crate) conf: crate::Config,
5    #[allow(dead_code)] // unused when a service does not provide any operations
6    pub(crate) runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
7}
8
9/// Client for Amazon Location Service Places V2
10///
11/// Client for invoking operations on Amazon Location Service Places V2. Each operation on Amazon Location Service Places V2 is a method on this
12/// this struct. `.send()` MUST be invoked on the generated operations to dispatch the request to the service.
13/// ## Constructing a `Client`
14///
15/// A [`Config`] is required to construct a client. For most use cases, the [`aws-config`]
16/// crate should be used to automatically resolve this config using
17/// [`aws_config::load_from_env()`], since this will resolve an [`SdkConfig`] which can be shared
18/// across multiple different AWS SDK clients. This config resolution process can be customized
19/// by calling [`aws_config::from_env()`] instead, which returns a [`ConfigLoader`] that uses
20/// the [builder pattern] to customize the default config.
21///
22/// In the simplest case, creating a client looks as follows:
23/// ```rust,no_run
24/// # async fn wrapper() {
25/// let config = aws_config::load_from_env().await;
26/// let client = aws_sdk_geoplaces::Client::new(&config);
27/// # }
28/// ```
29///
30/// Occasionally, SDKs may have additional service-specific values that can be set on the [`Config`] that
31/// is absent from [`SdkConfig`], or slightly different settings for a specific client may be desired.
32/// The [`Builder`](crate::config::Builder) struct implements `From<&SdkConfig>`, so setting these specific settings can be
33/// done as follows:
34///
35/// ```rust,no_run
36/// # async fn wrapper() {
37/// let sdk_config = ::aws_config::load_from_env().await;
38/// let config = aws_sdk_geoplaces::config::Builder::from(&sdk_config)
39/// # /*
40///     .some_service_specific_setting("value")
41/// # */
42///     .build();
43/// # }
44/// ```
45///
46/// See the [`aws-config` docs] and [`Config`] for more information on customizing configuration.
47///
48/// _Note:_ Client construction is expensive due to connection thread pool initialization, and should
49/// be done once at application start-up.
50///
51/// [`Config`]: crate::Config
52/// [`ConfigLoader`]: https://docs.rs/aws-config/*/aws_config/struct.ConfigLoader.html
53/// [`SdkConfig`]: https://docs.rs/aws-config/*/aws_config/struct.SdkConfig.html
54/// [`aws-config` docs]: https://docs.rs/aws-config/*
55/// [`aws-config`]: https://crates.io/crates/aws-config
56/// [`aws_config::from_env()`]: https://docs.rs/aws-config/*/aws_config/fn.from_env.html
57/// [`aws_config::load_from_env()`]: https://docs.rs/aws-config/*/aws_config/fn.load_from_env.html
58/// [builder pattern]: https://rust-lang.github.io/api-guidelines/type-safety.html#builders-enable-construction-of-complex-values-c-builder
59#[derive(::std::clone::Clone, ::std::fmt::Debug)]
60pub struct Client {
61    handle: ::std::sync::Arc<Handle>,
62}
63
64impl Client {
65    /// Creates a new client from the service [`Config`](crate::Config).
66    ///
67    /// # Panics
68    ///
69    /// This method will panic in the following cases:
70    ///
71    /// - Retries or timeouts are enabled without a `sleep_impl` configured.
72    /// - Identity caching is enabled without a `sleep_impl` and `time_source` configured.
73    /// - No `behavior_version` is provided.
74    ///
75    /// The panic message for each of these will have instructions on how to resolve them.
76    #[track_caller]
77    pub fn from_conf(conf: crate::Config) -> Self {
78        let handle = Handle {
79            conf: conf.clone(),
80            runtime_plugins: crate::config::base_client_runtime_plugins(conf),
81        };
82        if let Err(err) = Self::validate_config(&handle) {
83            panic!("Invalid client configuration: {err}");
84        }
85        Self {
86            handle: ::std::sync::Arc::new(handle),
87        }
88    }
89
90    /// Returns the client's configuration.
91    pub fn config(&self) -> &crate::Config {
92        &self.handle.conf
93    }
94
95    fn validate_config(handle: &Handle) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
96        let mut cfg = ::aws_smithy_types::config_bag::ConfigBag::base();
97        handle
98            .runtime_plugins
99            .apply_client_configuration(&mut cfg)?
100            .validate_base_client_config(&cfg)?;
101        Ok(())
102    }
103}
104
105impl Client {
106    /// Creates a new client from an [SDK Config](::aws_types::sdk_config::SdkConfig).
107    ///
108    /// # Panics
109    ///
110    /// - This method will panic if the `sdk_config` is missing an async sleep implementation. If you experience this panic, set
111    ///     the `sleep_impl` on the Config passed into this function to fix it.
112    /// - This method will panic if the `sdk_config` is missing an HTTP connector. If you experience this panic, set the
113    ///     `http_connector` on the Config passed into this function to fix it.
114    /// - This method will panic if no `BehaviorVersion` is provided. If you experience this panic, set `behavior_version` on the Config or enable the `behavior-version-latest` Cargo feature.
115    #[track_caller]
116    pub fn new(sdk_config: &::aws_types::sdk_config::SdkConfig) -> Self {
117        Self::from_conf(sdk_config.into())
118    }
119}
120
121mod autocomplete;
122
123/// Operation customization and supporting types.
124///
125pub mod customize;
126
127mod geocode;
128
129mod get_place;
130
131mod reverse_geocode;
132
133mod search_nearby;
134
135mod search_text;
136
137mod suggest;
aws_sdk_geoplaces/client.rs

aws_sdk_geoplaces/
client.rs
