aws_sdk_signin/config/
auth.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Auth scheme resolver trait specific to AWS Sign-In Service
3                pub trait ResolveAuthScheme: ::std::marker::Send + ::std::marker::Sync + ::std::fmt::Debug {
4                    /// Resolve a priority list of auth scheme options with the given parameters
5                    fn resolve_auth_scheme<'a>(
6                        &'a self,
7                        params: &'a crate::config::auth::Params,
8                        cfg: &'a ::aws_smithy_types::config_bag::ConfigBag,
9                        runtime_components: &'a ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponents,
10                    ) -> ::aws_smithy_runtime_api::client::auth::AuthSchemeOptionsFuture<'a>;
11
12                    /// Convert this service-specific resolver into a `SharedAuthSchemeOptionResolver`
13                    fn into_shared_resolver(self) -> ::aws_smithy_runtime_api::client::auth::SharedAuthSchemeOptionResolver
14                    where
15                        Self: ::std::marker::Sized + 'static,
16                    {
17                        ::aws_smithy_runtime_api::client::auth::SharedAuthSchemeOptionResolver::new(DowncastParams(self))
18                    }
19                }
20
21                #[derive(Debug)]
22                struct DowncastParams<T>(T);
23                impl<T> ::aws_smithy_runtime_api::client::auth::ResolveAuthSchemeOptions for DowncastParams<T>
24                where
25                    T: ResolveAuthScheme,
26                {
27                    fn resolve_auth_scheme_options_v2<'a>(
28                        &'a self,
29                        params: &'a ::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams,
30                        cfg: &'a ::aws_smithy_types::config_bag::ConfigBag,
31                        runtime_components: &'a ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponents,
32                    ) -> ::aws_smithy_runtime_api::client::auth::AuthSchemeOptionsFuture<'a> {
33                        match params.get::<crate::config::auth::Params>() {
34                            ::std::option::Option::Some(concrete_params) => self.0.resolve_auth_scheme(concrete_params, cfg, runtime_components),
35                            ::std::option::Option::None => ::aws_smithy_runtime_api::client::auth::AuthSchemeOptionsFuture::ready(::std::result::Result::Err("params of expected type was not present".into())),
36                        }
37                    }
38                }
39
40/// The default auth scheme resolver
41                #[derive(Debug)]
42                #[allow(dead_code)]
43                pub struct DefaultAuthSchemeResolver {
44                    service_defaults: Vec<::aws_smithy_runtime_api::client::auth::AuthSchemeOption>,
45                    operation_overrides: ::std::collections::HashMap<&'static str, Vec<::aws_smithy_runtime_api::client::auth::AuthSchemeOption>>,
46                }
47
48                // TODO(https://github.com/smithy-lang/smithy-rs/issues/4177): Remove `allow(...)` once the issue is addressed.
49                // When generating code for tests (e.g., `codegen-client-test`), this manual implementation
50                // of the `Default` trait may appear as if it could be derived automatically.
51                // However, that is not the case in production.
52                #[allow(clippy::derivable_impls)]
53                impl Default for DefaultAuthSchemeResolver {
54                    fn default() -> Self {
55                        Self {
56                            service_defaults: vec![::aws_smithy_runtime_api::client::auth::AuthSchemeOption::builder()
57            .scheme_id(::aws_runtime::auth::sigv4::SCHEME_ID)
58            
59            .build()
60            .expect("required fields set")],
61                            operation_overrides: [
62    ("CreateOAuth2Token", vec![::aws_smithy_runtime_api::client::auth::AuthSchemeOption::from(::aws_smithy_runtime::client::auth::no_auth::NO_AUTH_SCHEME_ID)])
63    ,
64]
65.into(),
66                        }
67                    }
68                }
69
70                impl crate::config::auth::ResolveAuthScheme for DefaultAuthSchemeResolver {
71                    fn resolve_auth_scheme<'a>(
72                        &'a self,
73                        params: &'a crate::config::auth::Params,
74                        _cfg: &'a ::aws_smithy_types::config_bag::ConfigBag,
75                        _runtime_components: &'a ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponents,
76                    ) -> ::aws_smithy_runtime_api::client::auth::AuthSchemeOptionsFuture<'a> {
77                        let operation_name = params.operation_name();
78
79                        let modeled_auth_options = match self.operation_overrides.get(operation_name) {
80                            Some(overrides) => overrides,
81                            None => &self.service_defaults,
82                        };
83
84                        let _fut = ::aws_smithy_runtime_api::client::auth::AuthSchemeOptionsFuture::ready(Ok(modeled_auth_options.clone()));
85
86                        
87
88                        _fut
89                    }
90                }
91
92/// Configuration parameters for resolving the correct auth scheme
93#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
94pub struct Params {
95    operation_name: ::std::borrow::Cow<'static, str>
96}
97impl Params {
98    /// Create a builder for [`Params`]
99                    pub fn builder() -> crate::config::auth::ParamsBuilder {
100                        crate::config::auth::ParamsBuilder::default()
101                    }
102    
103                    /// Return the operation name for [`Params`]
104                    pub fn operation_name(&self) -> &str {
105                        self.operation_name.as_ref()
106                    }
107}
108
109#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
110/// Builder for [`Params`]
111pub struct ParamsBuilder {
112    operation_name: ::std::option::Option<::std::borrow::Cow<'static, str>>,
113}
114impl ParamsBuilder {
115    /// Set the operation name for the builder
116                    pub fn operation_name(self, operation_name: impl Into<::std::borrow::Cow<'static, str>>) -> Self {
117                        self.set_operation_name(::std::option::Option::Some(operation_name.into()))
118                    }
119    
120                    /// Set the operation name for the builder
121                    pub fn set_operation_name(mut self, operation_name: ::std::option::Option<::std::borrow::Cow<'static, str>>) -> Self {
122                        self.operation_name = operation_name;
123                        self
124                    }
125    /// Consume this builder, create [`Params`]."
126    /// 
127    /// Return [`BuildError`] if any of the required fields are unset.
128    /// 
129    pub fn build(self) -> ::std::result::Result<crate::config::auth::Params, crate::config::auth::BuildError> {
130        ::std::result::Result::Ok(crate::config::auth::Params {
131                                operation_name: self.operation_name
132                                    .ok_or_else(||BuildError::missing("operation_name"))?
133                            })
134    }
135}
136
137/// An error that occurred while constructing `config::auth::Params`
138                #[derive(Debug)]
139                pub struct BuildError {
140                    field: ::std::borrow::Cow<'static, str>
141                }
142
143                impl BuildError {
144                    fn missing(field: &'static str) -> Self {
145                        Self { field: field.into() }
146                    }
147                }
148
149                impl std::fmt::Display for BuildError {
150                    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
151                        write!(f, "a required field was missing: `{}`", self.field)
152                    }
153                }
154
155                impl std::error::Error for BuildError { }
156