#[non_exhaustive]pub struct OidcConfigBuilder { /* private fields */ }
Expand description
A builder for OidcConfig
.
Implementations§
Source§impl OidcConfigBuilder
impl OidcConfigBuilder
Sourcepub fn client_id(self, input: impl Into<String>) -> Self
pub fn client_id(self, input: impl Into<String>) -> Self
The OIDC IdP client ID used to configure your private workforce.
This field is required.Sourcepub fn set_client_id(self, input: Option<String>) -> Self
pub fn set_client_id(self, input: Option<String>) -> Self
The OIDC IdP client ID used to configure your private workforce.
Sourcepub fn get_client_id(&self) -> &Option<String>
pub fn get_client_id(&self) -> &Option<String>
The OIDC IdP client ID used to configure your private workforce.
Sourcepub fn client_secret(self, input: impl Into<String>) -> Self
pub fn client_secret(self, input: impl Into<String>) -> Self
The OIDC IdP client secret used to configure your private workforce.
This field is required.Sourcepub fn set_client_secret(self, input: Option<String>) -> Self
pub fn set_client_secret(self, input: Option<String>) -> Self
The OIDC IdP client secret used to configure your private workforce.
Sourcepub fn get_client_secret(&self) -> &Option<String>
pub fn get_client_secret(&self) -> &Option<String>
The OIDC IdP client secret used to configure your private workforce.
Sourcepub fn issuer(self, input: impl Into<String>) -> Self
pub fn issuer(self, input: impl Into<String>) -> Self
The OIDC IdP issuer used to configure your private workforce.
This field is required.Sourcepub fn set_issuer(self, input: Option<String>) -> Self
pub fn set_issuer(self, input: Option<String>) -> Self
The OIDC IdP issuer used to configure your private workforce.
Sourcepub fn get_issuer(&self) -> &Option<String>
pub fn get_issuer(&self) -> &Option<String>
The OIDC IdP issuer used to configure your private workforce.
The OIDC IdP authorization endpoint used to configure your private workforce.
This field is required.The OIDC IdP authorization endpoint used to configure your private workforce.
The OIDC IdP authorization endpoint used to configure your private workforce.
Sourcepub fn token_endpoint(self, input: impl Into<String>) -> Self
pub fn token_endpoint(self, input: impl Into<String>) -> Self
The OIDC IdP token endpoint used to configure your private workforce.
This field is required.Sourcepub fn set_token_endpoint(self, input: Option<String>) -> Self
pub fn set_token_endpoint(self, input: Option<String>) -> Self
The OIDC IdP token endpoint used to configure your private workforce.
Sourcepub fn get_token_endpoint(&self) -> &Option<String>
pub fn get_token_endpoint(&self) -> &Option<String>
The OIDC IdP token endpoint used to configure your private workforce.
Sourcepub fn user_info_endpoint(self, input: impl Into<String>) -> Self
pub fn user_info_endpoint(self, input: impl Into<String>) -> Self
The OIDC IdP user information endpoint used to configure your private workforce.
This field is required.Sourcepub fn set_user_info_endpoint(self, input: Option<String>) -> Self
pub fn set_user_info_endpoint(self, input: Option<String>) -> Self
The OIDC IdP user information endpoint used to configure your private workforce.
Sourcepub fn get_user_info_endpoint(&self) -> &Option<String>
pub fn get_user_info_endpoint(&self) -> &Option<String>
The OIDC IdP user information endpoint used to configure your private workforce.
Sourcepub fn logout_endpoint(self, input: impl Into<String>) -> Self
pub fn logout_endpoint(self, input: impl Into<String>) -> Self
The OIDC IdP logout endpoint used to configure your private workforce.
This field is required.Sourcepub fn set_logout_endpoint(self, input: Option<String>) -> Self
pub fn set_logout_endpoint(self, input: Option<String>) -> Self
The OIDC IdP logout endpoint used to configure your private workforce.
Sourcepub fn get_logout_endpoint(&self) -> &Option<String>
pub fn get_logout_endpoint(&self) -> &Option<String>
The OIDC IdP logout endpoint used to configure your private workforce.
Sourcepub fn jwks_uri(self, input: impl Into<String>) -> Self
pub fn jwks_uri(self, input: impl Into<String>) -> Self
The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
This field is required.Sourcepub fn set_jwks_uri(self, input: Option<String>) -> Self
pub fn set_jwks_uri(self, input: Option<String>) -> Self
The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
Sourcepub fn get_jwks_uri(&self) -> &Option<String>
pub fn get_jwks_uri(&self) -> &Option<String>
The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
Sourcepub fn scope(self, input: impl Into<String>) -> Self
pub fn scope(self, input: impl Into<String>) -> Self
An array of string identifiers used to refer to the specific pieces of user data or claims that the client application wants to access.
Sourcepub fn set_scope(self, input: Option<String>) -> Self
pub fn set_scope(self, input: Option<String>) -> Self
An array of string identifiers used to refer to the specific pieces of user data or claims that the client application wants to access.
Sourcepub fn get_scope(&self) -> &Option<String>
pub fn get_scope(&self) -> &Option<String>
An array of string identifiers used to refer to the specific pieces of user data or claims that the client application wants to access.
Sourcepub fn authentication_request_extra_params(
self,
k: impl Into<String>,
v: impl Into<String>,
) -> Self
pub fn authentication_request_extra_params( self, k: impl Into<String>, v: impl Into<String>, ) -> Self
Adds a key-value pair to authentication_request_extra_params
.
To override the contents of this collection use set_authentication_request_extra_params
.
A string to string map of identifiers specific to the custom identity provider (IdP) being used.
Sourcepub fn set_authentication_request_extra_params(
self,
input: Option<HashMap<String, String>>,
) -> Self
pub fn set_authentication_request_extra_params( self, input: Option<HashMap<String, String>>, ) -> Self
A string to string map of identifiers specific to the custom identity provider (IdP) being used.
Sourcepub fn get_authentication_request_extra_params(
&self,
) -> &Option<HashMap<String, String>>
pub fn get_authentication_request_extra_params( &self, ) -> &Option<HashMap<String, String>>
A string to string map of identifiers specific to the custom identity provider (IdP) being used.
Sourcepub fn build(self) -> OidcConfig
pub fn build(self) -> OidcConfig
Consumes the builder and constructs a OidcConfig
.
Trait Implementations§
Source§impl Clone for OidcConfigBuilder
impl Clone for OidcConfigBuilder
Source§fn clone(&self) -> OidcConfigBuilder
fn clone(&self) -> OidcConfigBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for OidcConfigBuilder
impl Debug for OidcConfigBuilder
Source§impl Default for OidcConfigBuilder
impl Default for OidcConfigBuilder
Source§fn default() -> OidcConfigBuilder
fn default() -> OidcConfigBuilder
Source§impl PartialEq for OidcConfigBuilder
impl PartialEq for OidcConfigBuilder
impl StructuralPartialEq for OidcConfigBuilder
Auto Trait Implementations§
impl Freeze for OidcConfigBuilder
impl RefUnwindSafe for OidcConfigBuilder
impl Send for OidcConfigBuilder
impl Sync for OidcConfigBuilder
impl Unpin for OidcConfigBuilder
impl UnwindSafe for OidcConfigBuilder
Blanket Implementations§
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
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§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>
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>
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);