#[non_exhaustive]pub struct StartDeviceAuthorizationOutputBuilder { /* private fields */ }
Expand description
A builder for StartDeviceAuthorizationOutput
.
Implementations§
Source§impl StartDeviceAuthorizationOutputBuilder
impl StartDeviceAuthorizationOutputBuilder
Sourcepub fn device_code(self, input: impl Into<String>) -> Self
pub fn device_code(self, input: impl Into<String>) -> Self
The short-lived code that is used by the device when polling for a session token.
Sourcepub fn set_device_code(self, input: Option<String>) -> Self
pub fn set_device_code(self, input: Option<String>) -> Self
The short-lived code that is used by the device when polling for a session token.
Sourcepub fn get_device_code(&self) -> &Option<String>
pub fn get_device_code(&self) -> &Option<String>
The short-lived code that is used by the device when polling for a session token.
Sourcepub fn user_code(self, input: impl Into<String>) -> Self
pub fn user_code(self, input: impl Into<String>) -> Self
A one-time user verification code. This is needed to authorize an in-use device.
Sourcepub fn set_user_code(self, input: Option<String>) -> Self
pub fn set_user_code(self, input: Option<String>) -> Self
A one-time user verification code. This is needed to authorize an in-use device.
Sourcepub fn get_user_code(&self) -> &Option<String>
pub fn get_user_code(&self) -> &Option<String>
A one-time user verification code. This is needed to authorize an in-use device.
Sourcepub fn verification_uri(self, input: impl Into<String>) -> Self
pub fn verification_uri(self, input: impl Into<String>) -> Self
The URI of the verification page that takes the userCode
to authorize the device.
Sourcepub fn set_verification_uri(self, input: Option<String>) -> Self
pub fn set_verification_uri(self, input: Option<String>) -> Self
The URI of the verification page that takes the userCode
to authorize the device.
Sourcepub fn get_verification_uri(&self) -> &Option<String>
pub fn get_verification_uri(&self) -> &Option<String>
The URI of the verification page that takes the userCode
to authorize the device.
Sourcepub fn verification_uri_complete(self, input: impl Into<String>) -> Self
pub fn verification_uri_complete(self, input: impl Into<String>) -> Self
An alternate URL that the client can use to automatically launch a browser. This process skips the manual step in which the user visits the verification page and enters their code.
Sourcepub fn set_verification_uri_complete(self, input: Option<String>) -> Self
pub fn set_verification_uri_complete(self, input: Option<String>) -> Self
An alternate URL that the client can use to automatically launch a browser. This process skips the manual step in which the user visits the verification page and enters their code.
Sourcepub fn get_verification_uri_complete(&self) -> &Option<String>
pub fn get_verification_uri_complete(&self) -> &Option<String>
An alternate URL that the client can use to automatically launch a browser. This process skips the manual step in which the user visits the verification page and enters their code.
Sourcepub fn expires_in(self, input: i32) -> Self
pub fn expires_in(self, input: i32) -> Self
Indicates the number of seconds in which the verification code will become invalid.
Sourcepub fn set_expires_in(self, input: Option<i32>) -> Self
pub fn set_expires_in(self, input: Option<i32>) -> Self
Indicates the number of seconds in which the verification code will become invalid.
Sourcepub fn get_expires_in(&self) -> &Option<i32>
pub fn get_expires_in(&self) -> &Option<i32>
Indicates the number of seconds in which the verification code will become invalid.
Sourcepub fn interval(self, input: i32) -> Self
pub fn interval(self, input: i32) -> Self
Indicates the number of seconds the client must wait between attempts when polling for a session.
Sourcepub fn set_interval(self, input: Option<i32>) -> Self
pub fn set_interval(self, input: Option<i32>) -> Self
Indicates the number of seconds the client must wait between attempts when polling for a session.
Sourcepub fn get_interval(&self) -> &Option<i32>
pub fn get_interval(&self) -> &Option<i32>
Indicates the number of seconds the client must wait between attempts when polling for a session.
Sourcepub fn build(self) -> StartDeviceAuthorizationOutput
pub fn build(self) -> StartDeviceAuthorizationOutput
Consumes the builder and constructs a StartDeviceAuthorizationOutput
.
Trait Implementations§
Source§impl Clone for StartDeviceAuthorizationOutputBuilder
impl Clone for StartDeviceAuthorizationOutputBuilder
Source§fn clone(&self) -> StartDeviceAuthorizationOutputBuilder
fn clone(&self) -> StartDeviceAuthorizationOutputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for StartDeviceAuthorizationOutputBuilder
impl Default for StartDeviceAuthorizationOutputBuilder
Source§fn default() -> StartDeviceAuthorizationOutputBuilder
fn default() -> StartDeviceAuthorizationOutputBuilder
Source§impl PartialEq for StartDeviceAuthorizationOutputBuilder
impl PartialEq for StartDeviceAuthorizationOutputBuilder
Source§fn eq(&self, other: &StartDeviceAuthorizationOutputBuilder) -> bool
fn eq(&self, other: &StartDeviceAuthorizationOutputBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for StartDeviceAuthorizationOutputBuilder
Auto Trait Implementations§
impl Freeze for StartDeviceAuthorizationOutputBuilder
impl RefUnwindSafe for StartDeviceAuthorizationOutputBuilder
impl Send for StartDeviceAuthorizationOutputBuilder
impl Sync for StartDeviceAuthorizationOutputBuilder
impl Unpin for StartDeviceAuthorizationOutputBuilder
impl UnwindSafe for StartDeviceAuthorizationOutputBuilder
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);