aws_sdk_cloudfront::types::builders

Struct DistributionSummaryBuilder

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

A builder for DistributionSummary.

Implementations§

Source§

impl DistributionSummaryBuilder

Source

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

The identifier for the distribution. For example: EDFDVBD632BHDS5.

This field is required.
Source

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

The identifier for the distribution. For example: EDFDVBD632BHDS5.

Source

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

The identifier for the distribution. For example: EDFDVBD632BHDS5.

Source

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

The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your Amazon Web Services account ID.

This field is required.
Source

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

The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your Amazon Web Services account ID.

Source

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

The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your Amazon Web Services account ID.

Source

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

The current version of the distribution.

Source

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

The current version of the distribution.

Source

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

The current version of the distribution.

Source

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

The current status of the distribution. When the status is Deployed, the distribution's information is propagated to all CloudFront edge locations.

This field is required.
Source

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

The current status of the distribution. When the status is Deployed, the distribution's information is propagated to all CloudFront edge locations.

Source

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

The current status of the distribution. When the status is Deployed, the distribution's information is propagated to all CloudFront edge locations.

Source

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

The date and time the distribution was last modified.

This field is required.
Source

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

The date and time the distribution was last modified.

Source

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

The date and time the distribution was last modified.

Source

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

The domain name that corresponds to the distribution, for example, d111111abcdef8.cloudfront.net.

This field is required.
Source

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

The domain name that corresponds to the distribution, for example, d111111abcdef8.cloudfront.net.

Source

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

The domain name that corresponds to the distribution, for example, d111111abcdef8.cloudfront.net.

Source

pub fn aliases(self, input: Aliases) -> Self

A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

This field is required.
Source

pub fn set_aliases(self, input: Option<Aliases>) -> Self

A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

Source

pub fn get_aliases(&self) -> &Option<Aliases>

A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

Source

pub fn origins(self, input: Origins) -> Self

A complex type that contains information about origins for this distribution.

This field is required.
Source

pub fn set_origins(self, input: Option<Origins>) -> Self

A complex type that contains information about origins for this distribution.

Source

pub fn get_origins(&self) -> &Option<Origins>

A complex type that contains information about origins for this distribution.

Source

pub fn origin_groups(self, input: OriginGroups) -> Self

A complex type that contains information about origin groups for this distribution.

Source

pub fn set_origin_groups(self, input: Option<OriginGroups>) -> Self

A complex type that contains information about origin groups for this distribution.

Source

pub fn get_origin_groups(&self) -> &Option<OriginGroups>

A complex type that contains information about origin groups for this distribution.

Source

pub fn default_cache_behavior(self, input: DefaultCacheBehavior) -> Self

A complex type that describes the default cache behavior if you don't specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.

This field is required.
Source

pub fn set_default_cache_behavior( self, input: Option<DefaultCacheBehavior>, ) -> Self

A complex type that describes the default cache behavior if you don't specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.

Source

pub fn get_default_cache_behavior(&self) -> &Option<DefaultCacheBehavior>

A complex type that describes the default cache behavior if you don't specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.

Source

pub fn cache_behaviors(self, input: CacheBehaviors) -> Self

A complex type that contains zero or more CacheBehavior elements.

This field is required.
Source

pub fn set_cache_behaviors(self, input: Option<CacheBehaviors>) -> Self

A complex type that contains zero or more CacheBehavior elements.

Source

pub fn get_cache_behaviors(&self) -> &Option<CacheBehaviors>

A complex type that contains zero or more CacheBehavior elements.

Source

pub fn custom_error_responses(self, input: CustomErrorResponses) -> Self

A complex type that contains zero or more CustomErrorResponses elements.

This field is required.
Source

pub fn set_custom_error_responses( self, input: Option<CustomErrorResponses>, ) -> Self

A complex type that contains zero or more CustomErrorResponses elements.

Source

pub fn get_custom_error_responses(&self) -> &Option<CustomErrorResponses>

A complex type that contains zero or more CustomErrorResponses elements.

Source

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

The comment originally specified when this distribution was created.

This field is required.
Source

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

The comment originally specified when this distribution was created.

Source

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

The comment originally specified when this distribution was created.

Source

pub fn price_class(self, input: PriceClass) -> Self

A complex type that contains information about price class for this streaming distribution.

This field is required.
Source

pub fn set_price_class(self, input: Option<PriceClass>) -> Self

A complex type that contains information about price class for this streaming distribution.

Source

pub fn get_price_class(&self) -> &Option<PriceClass>

A complex type that contains information about price class for this streaming distribution.

Source

pub fn enabled(self, input: bool) -> Self

Whether the distribution is enabled to accept user requests for content.

This field is required.
Source

pub fn set_enabled(self, input: Option<bool>) -> Self

Whether the distribution is enabled to accept user requests for content.

Source

pub fn get_enabled(&self) -> &Option<bool>

Whether the distribution is enabled to accept user requests for content.

Source

pub fn viewer_certificate(self, input: ViewerCertificate) -> Self

A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers.

This field is required.
Source

pub fn set_viewer_certificate(self, input: Option<ViewerCertificate>) -> Self

A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers.

Source

pub fn get_viewer_certificate(&self) -> &Option<ViewerCertificate>

A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers.

Source

pub fn restrictions(self, input: Restrictions) -> Self

A complex type that identifies ways in which you want to restrict distribution of your content.

This field is required.
Source

pub fn set_restrictions(self, input: Option<Restrictions>) -> Self

A complex type that identifies ways in which you want to restrict distribution of your content.

Source

pub fn get_restrictions(&self) -> &Option<Restrictions>

A complex type that identifies ways in which you want to restrict distribution of your content.

Source

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

The Web ACL Id (if any) associated with the distribution.

This field is required.
Source

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

The Web ACL Id (if any) associated with the distribution.

Source

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

The Web ACL Id (if any) associated with the distribution.

Source

pub fn http_version(self, input: HttpVersion) -> Self

Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 will automatically use an earlier version.

This field is required.
Source

pub fn set_http_version(self, input: Option<HttpVersion>) -> Self

Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 will automatically use an earlier version.

Source

pub fn get_http_version(&self) -> &Option<HttpVersion>

Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 will automatically use an earlier version.

Source

pub fn is_ipv6_enabled(self, input: bool) -> Self

Whether CloudFront responds to IPv6 DNS requests with an IPv6 address for your distribution.

This field is required.
Source

pub fn set_is_ipv6_enabled(self, input: Option<bool>) -> Self

Whether CloudFront responds to IPv6 DNS requests with an IPv6 address for your distribution.

Source

pub fn get_is_ipv6_enabled(&self) -> &Option<bool>

Whether CloudFront responds to IPv6 DNS requests with an IPv6 address for your distribution.

Source

pub fn alias_icp_recordals(self, input: AliasIcpRecordal) -> Self

Appends an item to alias_icp_recordals.

To override the contents of this collection use set_alias_icp_recordals.

Amazon Web Services services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content publicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP recordal status for CNAMEs associated with distributions.

For more information about ICP recordals, see Signup, Accounts, and Credentials in Getting Started with Amazon Web Services services in China.

Source

pub fn set_alias_icp_recordals( self, input: Option<Vec<AliasIcpRecordal>>, ) -> Self

Amazon Web Services services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content publicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP recordal status for CNAMEs associated with distributions.

For more information about ICP recordals, see Signup, Accounts, and Credentials in Getting Started with Amazon Web Services services in China.

Source

pub fn get_alias_icp_recordals(&self) -> &Option<Vec<AliasIcpRecordal>>

Amazon Web Services services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content publicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP recordal status for CNAMEs associated with distributions.

For more information about ICP recordals, see Signup, Accounts, and Credentials in Getting Started with Amazon Web Services services in China.

Source

pub fn staging(self, input: bool) -> Self

A Boolean that indicates whether this is a staging distribution. When this value is true, this is a staging distribution. When this value is false, this is not a staging distribution.

This field is required.
Source

pub fn set_staging(self, input: Option<bool>) -> Self

A Boolean that indicates whether this is a staging distribution. When this value is true, this is a staging distribution. When this value is false, this is not a staging distribution.

Source

pub fn get_staging(&self) -> &Option<bool>

A Boolean that indicates whether this is a staging distribution. When this value is true, this is a staging distribution. When this value is false, this is not a staging distribution.

Source

pub fn connection_mode(self, input: ConnectionMode) -> Self

The connection mode to filter distributions by.

Source

pub fn set_connection_mode(self, input: Option<ConnectionMode>) -> Self

The connection mode to filter distributions by.

Source

pub fn get_connection_mode(&self) -> &Option<ConnectionMode>

The connection mode to filter distributions by.

Source

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

ID of the Anycast static IP list that is associated with the distribution.

Source

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

ID of the Anycast static IP list that is associated with the distribution.

Source

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

ID of the Anycast static IP list that is associated with the distribution.

Source

pub fn build(self) -> Result<DistributionSummary, BuildError>

Consumes the builder and constructs a DistributionSummary. This method will fail if any of the following fields are not set:

Trait Implementations§

Source§

impl Clone for DistributionSummaryBuilder

Source§

fn clone(&self) -> DistributionSummaryBuilder

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 DistributionSummaryBuilder

Source§

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

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

impl Default for DistributionSummaryBuilder

Source§

fn default() -> DistributionSummaryBuilder

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

impl PartialEq for DistributionSummaryBuilder

Source§

fn eq(&self, other: &DistributionSummaryBuilder) -> 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 DistributionSummaryBuilder

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,