DocumentDescriptionBuilder

Struct DocumentDescriptionBuilder 

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

A builder for DocumentDescription.

Implementations§

Source§

impl DocumentDescriptionBuilder

Source

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

The SHA1 hash of the document, which you can use for verification.

Source

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

The SHA1 hash of the document, which you can use for verification.

Source

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

The SHA1 hash of the document, which you can use for verification.

Source

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

The Sha256 or Sha1 hash created by the system when the document was created.

Sha1 hashes have been deprecated.

Source

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

The Sha256 or Sha1 hash created by the system when the document was created.

Sha1 hashes have been deprecated.

Source

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

The Sha256 or Sha1 hash created by the system when the document was created.

Sha1 hashes have been deprecated.

Source

pub fn hash_type(self, input: DocumentHashType) -> Self

The hash type of the document. Valid values include Sha256 or Sha1.

Sha1 hashes have been deprecated.

Source

pub fn set_hash_type(self, input: Option<DocumentHashType>) -> Self

The hash type of the document. Valid values include Sha256 or Sha1.

Sha1 hashes have been deprecated.

Source

pub fn get_hash_type(&self) -> &Option<DocumentHashType>

The hash type of the document. Valid values include Sha256 or Sha1.

Sha1 hashes have been deprecated.

Source

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

The name of the SSM document.

Source

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

The name of the SSM document.

Source

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

The name of the SSM document.

Source

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

The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.

Source

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

The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.

Source

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

The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.

Source

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

The version of the artifact associated with the document.

Source

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

The version of the artifact associated with the document.

Source

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

The version of the artifact associated with the document.

Source

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

The Amazon Web Services user that created the document.

Source

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

The Amazon Web Services user that created the document.

Source

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

The Amazon Web Services user that created the document.

Source

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

The date when the document was created.

Source

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

The date when the document was created.

Source

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

The date when the document was created.

Source

pub fn status(self, input: DocumentStatus) -> Self

The status of the SSM document.

Source

pub fn set_status(self, input: Option<DocumentStatus>) -> Self

The status of the SSM document.

Source

pub fn get_status(&self) -> &Option<DocumentStatus>

The status of the SSM document.

Source

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

A message returned by Amazon Web Services Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."

Source

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

A message returned by Amazon Web Services Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."

Source

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

A message returned by Amazon Web Services Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."

Source

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

The document version.

Source

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

The document version.

Source

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

The document version.

Source

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

A description of the document.

Source

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

A description of the document.

Source

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

A description of the document.

Source

pub fn parameters(self, input: DocumentParameter) -> Self

Appends an item to parameters.

To override the contents of this collection use set_parameters.

A description of the parameters for a document.

Source

pub fn set_parameters(self, input: Option<Vec<DocumentParameter>>) -> Self

A description of the parameters for a document.

Source

pub fn get_parameters(&self) -> &Option<Vec<DocumentParameter>>

A description of the parameters for a document.

Source

pub fn platform_types(self, input: PlatformType) -> Self

Appends an item to platform_types.

To override the contents of this collection use set_platform_types.

The list of operating system (OS) platforms compatible with this SSM document.

Source

pub fn set_platform_types(self, input: Option<Vec<PlatformType>>) -> Self

The list of operating system (OS) platforms compatible with this SSM document.

Source

pub fn get_platform_types(&self) -> &Option<Vec<PlatformType>>

The list of operating system (OS) platforms compatible with this SSM document.

Source

pub fn document_type(self, input: DocumentType) -> Self

The type of document.

Source

pub fn set_document_type(self, input: Option<DocumentType>) -> Self

The type of document.

Source

pub fn get_document_type(&self) -> &Option<DocumentType>

The type of document.

Source

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

The schema version.

Source

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

The schema version.

Source

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

The schema version.

Source

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

The latest version of the document.

Source

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

The latest version of the document.

Source

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

The latest version of the document.

Source

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

The default version.

Source

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

The default version.

Source

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

The default version.

Source

pub fn document_format(self, input: DocumentFormat) -> Self

The document format, either JSON or YAML.

Source

pub fn set_document_format(self, input: Option<DocumentFormat>) -> Self

The document format, either JSON or YAML.

Source

pub fn get_document_format(&self) -> &Option<DocumentFormat>

The document format, either JSON or YAML.

Source

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

The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.

Source

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

The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.

Source

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

The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.

Source

pub fn tags(self, input: Tag) -> Self

Appends an item to tags.

To override the contents of this collection use set_tags.

The tags, or metadata, that have been applied to the document.

Source

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

The tags, or metadata, that have been applied to the document.

Source

pub fn get_tags(&self) -> &Option<Vec<Tag>>

The tags, or metadata, that have been applied to the document.

Source

pub fn attachments_information(self, input: AttachmentInformation) -> Self

Appends an item to attachments_information.

To override the contents of this collection use set_attachments_information.

Details about the document attachments, including names, locations, sizes, and so on.

Source

pub fn set_attachments_information( self, input: Option<Vec<AttachmentInformation>>, ) -> Self

Details about the document attachments, including names, locations, sizes, and so on.

Source

pub fn get_attachments_information(&self) -> &Option<Vec<AttachmentInformation>>

Details about the document attachments, including names, locations, sizes, and so on.

Source

pub fn requires(self, input: DocumentRequires) -> Self

Appends an item to requires.

To override the contents of this collection use set_requires.

A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.

Source

pub fn set_requires(self, input: Option<Vec<DocumentRequires>>) -> Self

A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.

Source

pub fn get_requires(&self) -> &Option<Vec<DocumentRequires>>

A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.

Source

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

The user in your organization who created the document.

Source

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

The user in your organization who created the document.

Source

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

The user in your organization who created the document.

Source

pub fn review_information(self, input: ReviewInformation) -> Self

Appends an item to review_information.

To override the contents of this collection use set_review_information.

Details about the review of a document.

Source

pub fn set_review_information( self, input: Option<Vec<ReviewInformation>>, ) -> Self

Details about the review of a document.

Source

pub fn get_review_information(&self) -> &Option<Vec<ReviewInformation>>

Details about the review of a document.

Source

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

The version of the document currently approved for use in the organization.

Source

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

The version of the document currently approved for use in the organization.

Source

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

The version of the document currently approved for use in the organization.

Source

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

The version of the document that is currently under review.

Source

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

The version of the document that is currently under review.

Source

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

The version of the document that is currently under review.

Source

pub fn review_status(self, input: ReviewStatus) -> Self

The current status of the review.

Source

pub fn set_review_status(self, input: Option<ReviewStatus>) -> Self

The current status of the review.

Source

pub fn get_review_status(&self) -> &Option<ReviewStatus>

The current status of the review.

Source

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

Appends an item to category.

To override the contents of this collection use set_category.

The classification of a document to help you identify and categorize its use.

Source

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

The classification of a document to help you identify and categorize its use.

Source

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

The classification of a document to help you identify and categorize its use.

Source

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

Appends an item to category_enum.

To override the contents of this collection use set_category_enum.

The value that identifies a document's category.

Source

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

The value that identifies a document's category.

Source

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

The value that identifies a document's category.

Source

pub fn build(self) -> DocumentDescription

Consumes the builder and constructs a DocumentDescription.

Trait Implementations§

Source§

impl Clone for DocumentDescriptionBuilder

Source§

fn clone(&self) -> DocumentDescriptionBuilder

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

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DocumentDescriptionBuilder

Source§

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

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

impl Default for DocumentDescriptionBuilder

Source§

fn default() -> DocumentDescriptionBuilder

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

impl PartialEq for DocumentDescriptionBuilder

Source§

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

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

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 DocumentDescriptionBuilder

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,