aws_sdk_sagemaker::operation::describe_notebook_instance::builders

Struct DescribeNotebookInstanceOutputBuilder

Source 
#[non_exhaustive]
pub struct DescribeNotebookInstanceOutputBuilder { /* private fields */ }
Expand description

A builder for DescribeNotebookInstanceOutput.

Implementations§

Source§

impl DescribeNotebookInstanceOutputBuilder

Source

pub fn notebook_instance_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of the notebook instance.

Source

pub fn set_notebook_instance_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) of the notebook instance.

Source

pub fn get_notebook_instance_arn(&self) -> &Option<String>

The Amazon Resource Name (ARN) of the notebook instance.

Source

pub fn notebook_instance_name(self, input: impl Into<String>) -> Self

The name of the SageMaker AI notebook instance.

Source

pub fn set_notebook_instance_name(self, input: Option<String>) -> Self

The name of the SageMaker AI notebook instance.

Source

pub fn get_notebook_instance_name(&self) -> &Option<String>

The name of the SageMaker AI notebook instance.

Source

pub fn notebook_instance_status(self, input: NotebookInstanceStatus) -> Self

The status of the notebook instance.

Source

pub fn set_notebook_instance_status( self, input: Option<NotebookInstanceStatus>, ) -> Self

The status of the notebook instance.

Source

pub fn get_notebook_instance_status(&self) -> &Option<NotebookInstanceStatus>

The status of the notebook instance.

Source

pub fn failure_reason(self, input: impl Into<String>) -> Self

If status is Failed, the reason it failed.

Source

pub fn set_failure_reason(self, input: Option<String>) -> Self

If status is Failed, the reason it failed.

Source

pub fn get_failure_reason(&self) -> &Option<String>

If status is Failed, the reason it failed.

Source

pub fn url(self, input: impl Into<String>) -> Self

The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.

Source

pub fn set_url(self, input: Option<String>) -> Self

The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.

Source

pub fn get_url(&self) -> &Option<String>

The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.

Source

pub fn instance_type(self, input: InstanceType) -> Self

The type of ML compute instance running on the notebook instance.

Source

pub fn set_instance_type(self, input: Option<InstanceType>) -> Self

The type of ML compute instance running on the notebook instance.

Source

pub fn get_instance_type(&self) -> &Option<InstanceType>

The type of ML compute instance running on the notebook instance.

Source

pub fn subnet_id(self, input: impl Into<String>) -> Self

The ID of the VPC subnet.

Source

pub fn set_subnet_id(self, input: Option<String>) -> Self

The ID of the VPC subnet.

Source

pub fn get_subnet_id(&self) -> &Option<String>

The ID of the VPC subnet.

Source

pub fn security_groups(self, input: impl Into<String>) -> Self

Appends an item to security_groups.

To override the contents of this collection use set_security_groups.

The IDs of the VPC security groups.

Source

pub fn set_security_groups(self, input: Option<Vec<String>>) -> Self

The IDs of the VPC security groups.

Source

pub fn get_security_groups(&self) -> &Option<Vec<String>>

The IDs of the VPC security groups.

Source

pub fn role_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of the IAM role associated with the instance.

Source

pub fn set_role_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) of the IAM role associated with the instance.

Source

pub fn get_role_arn(&self) -> &Option<String>

The Amazon Resource Name (ARN) of the IAM role associated with the instance.

Source

pub fn kms_key_id(self, input: impl Into<String>) -> Self

The Amazon Web Services KMS key ID SageMaker AI uses to encrypt data when storing it on the ML storage volume attached to the instance.

Source

pub fn set_kms_key_id(self, input: Option<String>) -> Self

The Amazon Web Services KMS key ID SageMaker AI uses to encrypt data when storing it on the ML storage volume attached to the instance.

Source

pub fn get_kms_key_id(&self) -> &Option<String>

The Amazon Web Services KMS key ID SageMaker AI uses to encrypt data when storing it on the ML storage volume attached to the instance.

Source

pub fn network_interface_id(self, input: impl Into<String>) -> Self

The network interface IDs that SageMaker AI created at the time of creating the instance.

Source

pub fn set_network_interface_id(self, input: Option<String>) -> Self

The network interface IDs that SageMaker AI created at the time of creating the instance.

Source

pub fn get_network_interface_id(&self) -> &Option<String>

The network interface IDs that SageMaker AI created at the time of creating the instance.

Source

pub fn last_modified_time(self, input: DateTime) -> Self

A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.

Source

pub fn set_last_modified_time(self, input: Option<DateTime>) -> Self

A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.

Source

pub fn get_last_modified_time(&self) -> &Option<DateTime>

A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.

Source

pub fn creation_time(self, input: DateTime) -> Self

A timestamp. Use this parameter to return the time when the notebook instance was created

Source

pub fn set_creation_time(self, input: Option<DateTime>) -> Self

A timestamp. Use this parameter to return the time when the notebook instance was created

Source

pub fn get_creation_time(&self) -> &Option<DateTime>

A timestamp. Use this parameter to return the time when the notebook instance was created

Source

pub fn notebook_instance_lifecycle_config_name( self, input: impl Into<String>, ) -> Self

Returns the name of a notebook instance lifecycle configuration.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance

Source

pub fn set_notebook_instance_lifecycle_config_name( self, input: Option<String>, ) -> Self

Returns the name of a notebook instance lifecycle configuration.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance

Source

pub fn get_notebook_instance_lifecycle_config_name(&self) -> &Option<String>

Returns the name of a notebook instance lifecycle configuration.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance

Source

pub fn direct_internet_access(self, input: DirectInternetAccess) -> Self

Describes whether SageMaker AI provides internet access to the notebook instance. If this value is set to Disabled, the notebook instance does not have internet access, and cannot connect to SageMaker AI training and endpoint services.

For more information, see Notebook Instances Are Internet-Enabled by Default.

Source

pub fn set_direct_internet_access( self, input: Option<DirectInternetAccess>, ) -> Self

Describes whether SageMaker AI provides internet access to the notebook instance. If this value is set to Disabled, the notebook instance does not have internet access, and cannot connect to SageMaker AI training and endpoint services.

For more information, see Notebook Instances Are Internet-Enabled by Default.

Source

pub fn get_direct_internet_access(&self) -> &Option<DirectInternetAccess>

Describes whether SageMaker AI provides internet access to the notebook instance. If this value is set to Disabled, the notebook instance does not have internet access, and cannot connect to SageMaker AI training and endpoint services.

For more information, see Notebook Instances Are Internet-Enabled by Default.

Source

pub fn volume_size_in_gb(self, input: i32) -> Self

The size, in GB, of the ML storage volume attached to the notebook instance.

Source

pub fn set_volume_size_in_gb(self, input: Option<i32>) -> Self

The size, in GB, of the ML storage volume attached to the notebook instance.

Source

pub fn get_volume_size_in_gb(&self) -> &Option<i32>

The size, in GB, of the ML storage volume attached to the notebook instance.

Source

pub fn accelerator_types(self, input: NotebookInstanceAcceleratorType) -> Self

Appends an item to accelerator_types.

To override the contents of this collection use set_accelerator_types.

This parameter is no longer supported. Elastic Inference (EI) is no longer available.

This parameter was used to specify a list of the EI instance types associated with this notebook instance.

Source

pub fn set_accelerator_types( self, input: Option<Vec<NotebookInstanceAcceleratorType>>, ) -> Self

This parameter is no longer supported. Elastic Inference (EI) is no longer available.

This parameter was used to specify a list of the EI instance types associated with this notebook instance.

Source

pub fn get_accelerator_types( &self, ) -> &Option<Vec<NotebookInstanceAcceleratorType>>

This parameter is no longer supported. Elastic Inference (EI) is no longer available.

This parameter was used to specify a list of the EI instance types associated with this notebook instance.

Source

pub fn default_code_repository(self, input: impl Into<String>) -> Self

The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker AI Notebook Instances.

Source

pub fn set_default_code_repository(self, input: Option<String>) -> Self

The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker AI Notebook Instances.

Source

pub fn get_default_code_repository(&self) -> &Option<String>

The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker AI Notebook Instances.

Source

pub fn additional_code_repositories(self, input: impl Into<String>) -> Self

Appends an item to additional_code_repositories.

To override the contents of this collection use set_additional_code_repositories.

An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker AI Notebook Instances.

Source

pub fn set_additional_code_repositories( self, input: Option<Vec<String>>, ) -> Self

An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker AI Notebook Instances.

Source

pub fn get_additional_code_repositories(&self) -> &Option<Vec<String>>

An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker AI Notebook Instances.

Source

pub fn root_access(self, input: RootAccess) -> Self

Whether root access is enabled or disabled for users of the notebook instance.

Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.

Source

pub fn set_root_access(self, input: Option<RootAccess>) -> Self

Whether root access is enabled or disabled for users of the notebook instance.

Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.

Source

pub fn get_root_access(&self) -> &Option<RootAccess>

Whether root access is enabled or disabled for users of the notebook instance.

Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.

Source

pub fn platform_identifier(self, input: impl Into<String>) -> Self

The platform identifier of the notebook instance runtime environment.

Source

pub fn set_platform_identifier(self, input: Option<String>) -> Self

The platform identifier of the notebook instance runtime environment.

Source

pub fn get_platform_identifier(&self) -> &Option<String>

The platform identifier of the notebook instance runtime environment.

Source

pub fn instance_metadata_service_configuration( self, input: InstanceMetadataServiceConfiguration, ) -> Self

Information on the IMDS configuration of the notebook instance

Source

pub fn set_instance_metadata_service_configuration( self, input: Option<InstanceMetadataServiceConfiguration>, ) -> Self

Information on the IMDS configuration of the notebook instance

Source

pub fn get_instance_metadata_service_configuration( &self, ) -> &Option<InstanceMetadataServiceConfiguration>

Information on the IMDS configuration of the notebook instance

Source

pub fn build(self) -> DescribeNotebookInstanceOutput

Consumes the builder and constructs a DescribeNotebookInstanceOutput.

Trait Implementations§

Source§

impl Clone for DescribeNotebookInstanceOutputBuilder

Source§

fn clone(&self) -> DescribeNotebookInstanceOutputBuilder

Returns a duplicate of the value. Read more
1.0.0 · Source§

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for DescribeNotebookInstanceOutputBuilder

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for DescribeNotebookInstanceOutputBuilder

Source§

fn default() -> DescribeNotebookInstanceOutputBuilder

Returns the “default value” for a type. Read more
Source§

impl PartialEq for DescribeNotebookInstanceOutputBuilder

Source§

fn eq(&self, other: &DescribeNotebookInstanceOutputBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for DescribeNotebookInstanceOutputBuilder

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> Paint for T
where T: ?Sized,

Source§

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 primary(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Primary].

§Example
println!("{}", value.primary());
Source§

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Fixed].

§Example
println!("{}", value.fixed(color));
Source§

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Rgb].

§Example
println!("{}", value.rgb(r, g, b));
Source§

fn black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Black].

§Example
println!("{}", value.black());
Source§

fn red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Red].

§Example
println!("{}", value.red());
Source§

fn green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Green].

§Example
println!("{}", value.green());
Source§

fn yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Yellow].

§Example
println!("{}", value.yellow());
Source§

fn blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Blue].

§Example
println!("{}", value.blue());
Source§

fn magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Magenta].

§Example
println!("{}", value.magenta());
Source§

fn cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Cyan].

§Example
println!("{}", value.cyan());
Source§

fn white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: White].

§Example
println!("{}", value.white());
Source§

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>

Returns self with the fg() set to [Color :: BrightRed].

§Example
println!("{}", value.bright_red());
Source§

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>

Returns self with the fg() set to [Color :: BrightYellow].

§Example
println!("{}", value.bright_yellow());
Source§

fn bright_blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlue].

§Example
println!("{}", value.bright_blue());
Source§

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>

Returns self with the fg() set to [Color :: BrightCyan].

§Example
println!("{}", value.bright_cyan());
Source§

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>

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>

Returns self with the bg() set to [Color :: Primary].

§Example
println!("{}", value.on_primary());
Source§

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Fixed].

§Example
println!("{}", value.on_fixed(color));
Source§

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Rgb].

§Example
println!("{}", value.on_rgb(r, g, b));
Source§

fn on_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Black].

§Example
println!("{}", value.on_black());
Source§

fn on_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Red].

§Example
println!("{}", value.on_red());
Source§

fn on_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Green].

§Example
println!("{}", value.on_green());
Source§

fn on_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Yellow].

§Example
println!("{}", value.on_yellow());
Source§

fn on_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Blue].

§Example
println!("{}", value.on_blue());
Source§

fn on_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Magenta].

§Example
println!("{}", value.on_magenta());
Source§

fn on_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Cyan].

§Example
println!("{}", value.on_cyan());
Source§

fn on_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: White].

§Example
println!("{}", value.on_white());
Source§

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>

Returns self with the bg() set to [Color :: BrightRed].

§Example
println!("{}", value.on_bright_red());
Source§

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>

Returns self with the bg() set to [Color :: BrightYellow].

§Example
println!("{}", value.on_bright_yellow());
Source§

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>

Returns self with the bg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.on_bright_magenta());
Source§

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>

Returns self with the bg() set to [Color :: BrightWhite].

§Example
println!("{}", value.on_bright_white());
Source§

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 bold(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Bold].

§Example
println!("{}", value.bold());
Source§

fn dim(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Dim].

§Example
println!("{}", value.dim());
Source§

fn italic(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Italic].

§Example
println!("{}", value.italic());
Source§

fn underline(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Underline].

§Example
println!("{}", value.underline());

Returns self with the attr() set to [Attribute :: Blink].

§Example
println!("{}", value.blink());

Returns self with the attr() set to [Attribute :: RapidBlink].

§Example
println!("{}", value.rapid_blink());
Source§

fn invert(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Invert].

§Example
println!("{}", value.invert());
Source§

fn conceal(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Conceal].

§Example
println!("{}", value.conceal());
Source§

fn strike(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Strike].

§Example
println!("{}", value.strike());
Source§

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 mask(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Mask].

§Example
println!("{}", value.mask());
Source§

fn wrap(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Wrap].

§Example
println!("{}", value.wrap());
Source§

fn linger(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Linger].

§Example
println!("{}", value.linger());
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.

Returns self with the quirk() set to [Quirk :: Clear].

§Example
println!("{}", value.clear());
Source§

fn resetting(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Resetting].

§Example
println!("{}", value.resetting());
Source§

fn bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Bright].

§Example
println!("{}", value.bright());
Source§

fn on_bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: OnBright].

§Example
println!("{}", value.on_bright());
Source§

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);
Source§

fn new(self) -> Painted<Self>
where Self: Sized,

Create a new Painted with a default Style. Read more
Source§

fn paint<S>(&self, style: S) -> Painted<&Self>
where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,