#[non_exhaustive]pub struct EnvironmentBuilder { /* private fields */ }
Expand description
A builder for Environment
.
Implementations§
Source§impl EnvironmentBuilder
impl EnvironmentBuilder
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
The description for the environment.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
The description for the environment.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
The description for the environment.
Sourcepub fn type(self, input: EnvironmentType) -> Self
pub fn type(self, input: EnvironmentType) -> Self
The type of environment. Valid values include the following:
-
ec2
: An Amazon Elastic Compute Cloud (Amazon EC2) instance connects to the environment. -
ssh
: Your own server connects to the environment.
Sourcepub fn set_type(self, input: Option<EnvironmentType>) -> Self
pub fn set_type(self, input: Option<EnvironmentType>) -> Self
The type of environment. Valid values include the following:
-
ec2
: An Amazon Elastic Compute Cloud (Amazon EC2) instance connects to the environment. -
ssh
: Your own server connects to the environment.
Sourcepub fn get_type(&self) -> &Option<EnvironmentType>
pub fn get_type(&self) -> &Option<EnvironmentType>
The type of environment. Valid values include the following:
-
ec2
: An Amazon Elastic Compute Cloud (Amazon EC2) instance connects to the environment. -
ssh
: Your own server connects to the environment.
Sourcepub fn connection_type(self, input: ConnectionType) -> Self
pub fn connection_type(self, input: ConnectionType) -> Self
The connection type used for connecting to an Amazon EC2 environment. CONNECT_SSH
is selected by default.
Sourcepub fn set_connection_type(self, input: Option<ConnectionType>) -> Self
pub fn set_connection_type(self, input: Option<ConnectionType>) -> Self
The connection type used for connecting to an Amazon EC2 environment. CONNECT_SSH
is selected by default.
Sourcepub fn get_connection_type(&self) -> &Option<ConnectionType>
pub fn get_connection_type(&self) -> &Option<ConnectionType>
The connection type used for connecting to an Amazon EC2 environment. CONNECT_SSH
is selected by default.
Sourcepub fn arn(self, input: impl Into<String>) -> Self
pub fn arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the environment.
This field is required.Sourcepub fn set_arn(self, input: Option<String>) -> Self
pub fn set_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the environment.
Sourcepub fn owner_arn(self, input: impl Into<String>) -> Self
pub fn owner_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the environment owner.
This field is required.Sourcepub fn set_owner_arn(self, input: Option<String>) -> Self
pub fn set_owner_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the environment owner.
Sourcepub fn get_owner_arn(&self) -> &Option<String>
pub fn get_owner_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the environment owner.
Sourcepub fn lifecycle(self, input: EnvironmentLifecycle) -> Self
pub fn lifecycle(self, input: EnvironmentLifecycle) -> Self
The state of the environment in its creation or deletion lifecycle.
Sourcepub fn set_lifecycle(self, input: Option<EnvironmentLifecycle>) -> Self
pub fn set_lifecycle(self, input: Option<EnvironmentLifecycle>) -> Self
The state of the environment in its creation or deletion lifecycle.
Sourcepub fn get_lifecycle(&self) -> &Option<EnvironmentLifecycle>
pub fn get_lifecycle(&self) -> &Option<EnvironmentLifecycle>
The state of the environment in its creation or deletion lifecycle.
Sourcepub fn managed_credentials_status(self, input: ManagedCredentialsStatus) -> Self
pub fn managed_credentials_status(self, input: ManagedCredentialsStatus) -> Self
Describes the status of Amazon Web Services managed temporary credentials for the Cloud9 environment. Available values are:
-
ENABLED_ON_CREATE
-
ENABLED_BY_OWNER
-
DISABLED_BY_DEFAULT
-
DISABLED_BY_OWNER
-
DISABLED_BY_COLLABORATOR
-
PENDING_REMOVAL_BY_COLLABORATOR
-
PENDING_REMOVAL_BY_OWNER
-
FAILED_REMOVAL_BY_COLLABORATOR
-
ENABLED_BY_OWNER
-
DISABLED_BY_DEFAULT
Sourcepub fn set_managed_credentials_status(
self,
input: Option<ManagedCredentialsStatus>,
) -> Self
pub fn set_managed_credentials_status( self, input: Option<ManagedCredentialsStatus>, ) -> Self
Describes the status of Amazon Web Services managed temporary credentials for the Cloud9 environment. Available values are:
-
ENABLED_ON_CREATE
-
ENABLED_BY_OWNER
-
DISABLED_BY_DEFAULT
-
DISABLED_BY_OWNER
-
DISABLED_BY_COLLABORATOR
-
PENDING_REMOVAL_BY_COLLABORATOR
-
PENDING_REMOVAL_BY_OWNER
-
FAILED_REMOVAL_BY_COLLABORATOR
-
ENABLED_BY_OWNER
-
DISABLED_BY_DEFAULT
Sourcepub fn get_managed_credentials_status(
&self,
) -> &Option<ManagedCredentialsStatus>
pub fn get_managed_credentials_status( &self, ) -> &Option<ManagedCredentialsStatus>
Describes the status of Amazon Web Services managed temporary credentials for the Cloud9 environment. Available values are:
-
ENABLED_ON_CREATE
-
ENABLED_BY_OWNER
-
DISABLED_BY_DEFAULT
-
DISABLED_BY_OWNER
-
DISABLED_BY_COLLABORATOR
-
PENDING_REMOVAL_BY_COLLABORATOR
-
PENDING_REMOVAL_BY_OWNER
-
FAILED_REMOVAL_BY_COLLABORATOR
-
ENABLED_BY_OWNER
-
DISABLED_BY_DEFAULT
Sourcepub fn build(self) -> Result<Environment, BuildError>
pub fn build(self) -> Result<Environment, BuildError>
Consumes the builder and constructs a Environment
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for EnvironmentBuilder
impl Clone for EnvironmentBuilder
Source§fn clone(&self) -> EnvironmentBuilder
fn clone(&self) -> EnvironmentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for EnvironmentBuilder
impl Debug for EnvironmentBuilder
Source§impl Default for EnvironmentBuilder
impl Default for EnvironmentBuilder
Source§fn default() -> EnvironmentBuilder
fn default() -> EnvironmentBuilder
Source§impl PartialEq for EnvironmentBuilder
impl PartialEq for EnvironmentBuilder
impl StructuralPartialEq for EnvironmentBuilder
Auto Trait Implementations§
impl Freeze for EnvironmentBuilder
impl RefUnwindSafe for EnvironmentBuilder
impl Send for EnvironmentBuilder
impl Sync for EnvironmentBuilder
impl Unpin for EnvironmentBuilder
impl UnwindSafe for EnvironmentBuilder
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);