#[non_exhaustive]pub struct OpenIdConnectConfigurationBuilder { /* private fields */ }
Expand description
A builder for OpenIdConnectConfiguration
.
Implementations§
Source§impl OpenIdConnectConfigurationBuilder
impl OpenIdConnectConfigurationBuilder
Sourcepub fn issuer(self, input: impl Into<String>) -> Self
pub fn issuer(self, input: impl Into<String>) -> Self
The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery endpoint at the path .well-known/openid-configuration
.
Sourcepub fn set_issuer(self, input: Option<String>) -> Self
pub fn set_issuer(self, input: Option<String>) -> Self
The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery endpoint at the path .well-known/openid-configuration
.
Sourcepub fn get_issuer(&self) -> &Option<String>
pub fn get_issuer(&self) -> &Option<String>
The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery endpoint at the path .well-known/openid-configuration
.
Sourcepub fn entity_id_prefix(self, input: impl Into<String>) -> Self
pub fn entity_id_prefix(self, input: impl Into<String>) -> Self
A descriptive string that you want to prefix to user entities from your OIDC identity provider. For example, if you set an entityIdPrefix
of MyOIDCProvider
, you can reference principals in your policies in the format MyCorp::User::MyOIDCProvider|Carlos
.
Sourcepub fn set_entity_id_prefix(self, input: Option<String>) -> Self
pub fn set_entity_id_prefix(self, input: Option<String>) -> Self
A descriptive string that you want to prefix to user entities from your OIDC identity provider. For example, if you set an entityIdPrefix
of MyOIDCProvider
, you can reference principals in your policies in the format MyCorp::User::MyOIDCProvider|Carlos
.
Sourcepub fn get_entity_id_prefix(&self) -> &Option<String>
pub fn get_entity_id_prefix(&self) -> &Option<String>
A descriptive string that you want to prefix to user entities from your OIDC identity provider. For example, if you set an entityIdPrefix
of MyOIDCProvider
, you can reference principals in your policies in the format MyCorp::User::MyOIDCProvider|Carlos
.
Sourcepub fn group_configuration(self, input: OpenIdConnectGroupConfiguration) -> Self
pub fn group_configuration(self, input: OpenIdConnectGroupConfiguration) -> Self
The claim in OIDC identity provider tokens that indicates a user's group membership, and the entity type that you want to map it to. For example, this object can map the contents of a groups
claim to MyCorp::UserGroup
.
Sourcepub fn set_group_configuration(
self,
input: Option<OpenIdConnectGroupConfiguration>,
) -> Self
pub fn set_group_configuration( self, input: Option<OpenIdConnectGroupConfiguration>, ) -> Self
The claim in OIDC identity provider tokens that indicates a user's group membership, and the entity type that you want to map it to. For example, this object can map the contents of a groups
claim to MyCorp::UserGroup
.
Sourcepub fn get_group_configuration(
&self,
) -> &Option<OpenIdConnectGroupConfiguration>
pub fn get_group_configuration( &self, ) -> &Option<OpenIdConnectGroupConfiguration>
The claim in OIDC identity provider tokens that indicates a user's group membership, and the entity type that you want to map it to. For example, this object can map the contents of a groups
claim to MyCorp::UserGroup
.
Sourcepub fn token_selection(self, input: OpenIdConnectTokenSelection) -> Self
pub fn token_selection(self, input: OpenIdConnectTokenSelection) -> Self
The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source.
This field is required.Sourcepub fn set_token_selection(
self,
input: Option<OpenIdConnectTokenSelection>,
) -> Self
pub fn set_token_selection( self, input: Option<OpenIdConnectTokenSelection>, ) -> Self
The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source.
Sourcepub fn get_token_selection(&self) -> &Option<OpenIdConnectTokenSelection>
pub fn get_token_selection(&self) -> &Option<OpenIdConnectTokenSelection>
The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source.
Sourcepub fn build(self) -> Result<OpenIdConnectConfiguration, BuildError>
pub fn build(self) -> Result<OpenIdConnectConfiguration, BuildError>
Consumes the builder and constructs a OpenIdConnectConfiguration
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for OpenIdConnectConfigurationBuilder
impl Clone for OpenIdConnectConfigurationBuilder
Source§fn clone(&self) -> OpenIdConnectConfigurationBuilder
fn clone(&self) -> OpenIdConnectConfigurationBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for OpenIdConnectConfigurationBuilder
impl Default for OpenIdConnectConfigurationBuilder
Source§fn default() -> OpenIdConnectConfigurationBuilder
fn default() -> OpenIdConnectConfigurationBuilder
Source§impl PartialEq for OpenIdConnectConfigurationBuilder
impl PartialEq for OpenIdConnectConfigurationBuilder
Source§fn eq(&self, other: &OpenIdConnectConfigurationBuilder) -> bool
fn eq(&self, other: &OpenIdConnectConfigurationBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for OpenIdConnectConfigurationBuilder
Auto Trait Implementations§
impl Freeze for OpenIdConnectConfigurationBuilder
impl RefUnwindSafe for OpenIdConnectConfigurationBuilder
impl Send for OpenIdConnectConfigurationBuilder
impl Sync for OpenIdConnectConfigurationBuilder
impl Unpin for OpenIdConnectConfigurationBuilder
impl UnwindSafe for OpenIdConnectConfigurationBuilder
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§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)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>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
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>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
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>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
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>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
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>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
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>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
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 underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
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);