aws_sdk_appsync::types::builders

Struct GraphqlApiBuilder

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

A builder for GraphqlApi.

Implementations§

Source§

impl GraphqlApiBuilder

Source

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

The API name.

Source

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

The API name.

Source

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

The API name.

Source

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

The API ID.

Source

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

The API ID.

Source

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

The API ID.

Source

pub fn authentication_type(self, input: AuthenticationType) -> Self

The authentication type.

Source

pub fn set_authentication_type(self, input: Option<AuthenticationType>) -> Self

The authentication type.

Source

pub fn get_authentication_type(&self) -> &Option<AuthenticationType>

The authentication type.

Source

pub fn log_config(self, input: LogConfig) -> Self

The Amazon CloudWatch Logs configuration.

Source

pub fn set_log_config(self, input: Option<LogConfig>) -> Self

The Amazon CloudWatch Logs configuration.

Source

pub fn get_log_config(&self) -> &Option<LogConfig>

The Amazon CloudWatch Logs configuration.

Source

pub fn user_pool_config(self, input: UserPoolConfig) -> Self

The Amazon Cognito user pool configuration.

Source

pub fn set_user_pool_config(self, input: Option<UserPoolConfig>) -> Self

The Amazon Cognito user pool configuration.

Source

pub fn get_user_pool_config(&self) -> &Option<UserPoolConfig>

The Amazon Cognito user pool configuration.

Source

pub fn open_id_connect_config(self, input: OpenIdConnectConfig) -> Self

The OpenID Connect configuration.

Source

pub fn set_open_id_connect_config( self, input: Option<OpenIdConnectConfig>, ) -> Self

The OpenID Connect configuration.

Source

pub fn get_open_id_connect_config(&self) -> &Option<OpenIdConnectConfig>

The OpenID Connect configuration.

Source

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

The Amazon Resource Name (ARN).

Source

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

The Amazon Resource Name (ARN).

Source

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

The Amazon Resource Name (ARN).

Source

pub fn uris(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to uris.

To override the contents of this collection use set_uris.

The URIs.

Source

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

The URIs.

Source

pub fn get_uris(&self) -> &Option<HashMap<String, String>>

The URIs.

Source

pub fn tags(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to tags.

To override the contents of this collection use set_tags.

The tags.

Source

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

The tags.

Source

pub fn get_tags(&self) -> &Option<HashMap<String, String>>

The tags.

Source

pub fn additional_authentication_providers( self, input: AdditionalAuthenticationProvider, ) -> Self

Appends an item to additional_authentication_providers.

To override the contents of this collection use set_additional_authentication_providers.

A list of additional authentication providers for the GraphqlApi API.

Source

pub fn set_additional_authentication_providers( self, input: Option<Vec<AdditionalAuthenticationProvider>>, ) -> Self

A list of additional authentication providers for the GraphqlApi API.

Source

pub fn get_additional_authentication_providers( &self, ) -> &Option<Vec<AdditionalAuthenticationProvider>>

A list of additional authentication providers for the GraphqlApi API.

Source

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

A flag indicating whether to use X-Ray tracing for this GraphqlApi.

Source

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

A flag indicating whether to use X-Ray tracing for this GraphqlApi.

Source

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

A flag indicating whether to use X-Ray tracing for this GraphqlApi.

Source

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

The ARN of the WAF access control list (ACL) associated with this GraphqlApi, if one exists.

Source

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

The ARN of the WAF access control list (ACL) associated with this GraphqlApi, if one exists.

Source

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

The ARN of the WAF access control list (ACL) associated with this GraphqlApi, if one exists.

Source

pub fn lambda_authorizer_config(self, input: LambdaAuthorizerConfig) -> Self

Configuration for Lambda function authorization.

Source

pub fn set_lambda_authorizer_config( self, input: Option<LambdaAuthorizerConfig>, ) -> Self

Configuration for Lambda function authorization.

Source

pub fn get_lambda_authorizer_config(&self) -> &Option<LambdaAuthorizerConfig>

Configuration for Lambda function authorization.

Source

pub fn dns(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to dns.

To override the contents of this collection use set_dns.

The DNS records for the API.

Source

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

The DNS records for the API.

Source

pub fn get_dns(&self) -> &Option<HashMap<String, String>>

The DNS records for the API.

Source

pub fn visibility(self, input: GraphQlApiVisibility) -> Self

Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE). If no value is provided, the visibility will be set to GLOBAL by default. This value cannot be changed once the API has been created.

Source

pub fn set_visibility(self, input: Option<GraphQlApiVisibility>) -> Self

Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE). If no value is provided, the visibility will be set to GLOBAL by default. This value cannot be changed once the API has been created.

Source

pub fn get_visibility(&self) -> &Option<GraphQlApiVisibility>

Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE). If no value is provided, the visibility will be set to GLOBAL by default. This value cannot be changed once the API has been created.

Source

pub fn api_type(self, input: GraphQlApiType) -> Self

The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API (MERGED).

Source

pub fn set_api_type(self, input: Option<GraphQlApiType>) -> Self

The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API (MERGED).

Source

pub fn get_api_type(&self) -> &Option<GraphQlApiType>

The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API (MERGED).

Source

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

The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role on behalf of the Merged API to validate access to source APIs at runtime and to prompt the AUTO_MERGE to update the merged API endpoint with the source API changes automatically.

Source

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

The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role on behalf of the Merged API to validate access to source APIs at runtime and to prompt the AUTO_MERGE to update the merged API endpoint with the source API changes automatically.

Source

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

The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role on behalf of the Merged API to validate access to source APIs at runtime and to prompt the AUTO_MERGE to update the merged API endpoint with the source API changes automatically.

Source

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

The account owner of the GraphQL API.

Source

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

The account owner of the GraphQL API.

Source

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

The account owner of the GraphQL API.

Source

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

The owner contact information for an API resource.

This field accepts any string input with a length of 0 - 256 characters.

Source

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

The owner contact information for an API resource.

This field accepts any string input with a length of 0 - 256 characters.

Source

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

The owner contact information for an API resource.

This field accepts any string input with a length of 0 - 256 characters.

Source

pub fn introspection_config(self, input: GraphQlApiIntrospectionConfig) -> Self

Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED) introspection. If no value is provided, the introspection configuration will be set to ENABLED by default. This field will produce an error if the operation attempts to use the introspection feature while this field is disabled.

For more information about introspection, see GraphQL introspection.

Source

pub fn set_introspection_config( self, input: Option<GraphQlApiIntrospectionConfig>, ) -> Self

Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED) introspection. If no value is provided, the introspection configuration will be set to ENABLED by default. This field will produce an error if the operation attempts to use the introspection feature while this field is disabled.

For more information about introspection, see GraphQL introspection.

Source

pub fn get_introspection_config(&self) -> &Option<GraphQlApiIntrospectionConfig>

Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED) introspection. If no value is provided, the introspection configuration will be set to ENABLED by default. This field will produce an error if the operation attempts to use the introspection feature while this field is disabled.

For more information about introspection, see GraphQL introspection.

Source

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

The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed in the body of query. The default value is 0 (or unspecified), which indicates there's no depth limit. If you set a limit, it can be between 1 and 75 nested levels. This field will produce a limit error if the operation falls out of bounds.

Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error, the error will be thrown upwards to the first nullable field available.

Source

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

The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed in the body of query. The default value is 0 (or unspecified), which indicates there's no depth limit. If you set a limit, it can be between 1 and 75 nested levels. This field will produce a limit error if the operation falls out of bounds.

Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error, the error will be thrown upwards to the first nullable field available.

Source

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

The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed in the body of query. The default value is 0 (or unspecified), which indicates there's no depth limit. If you set a limit, it can be between 1 and 75 nested levels. This field will produce a limit error if the operation falls out of bounds.

Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error, the error will be thrown upwards to the first nullable field available.

Source

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

The maximum number of resolvers that can be invoked in a single request. The default value is 0 (or unspecified), which will set the limit to 10000. When specified, the limit value can be between 1 and 10000. This field will produce a limit error if the operation falls out of bounds.

Source

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

The maximum number of resolvers that can be invoked in a single request. The default value is 0 (or unspecified), which will set the limit to 10000. When specified, the limit value can be between 1 and 10000. This field will produce a limit error if the operation falls out of bounds.

Source

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

The maximum number of resolvers that can be invoked in a single request. The default value is 0 (or unspecified), which will set the limit to 10000. When specified, the limit value can be between 1 and 10000. This field will produce a limit error if the operation falls out of bounds.

Source

pub fn enhanced_metrics_config(self, input: EnhancedMetricsConfig) -> Self

The enhancedMetricsConfig object.

Source

pub fn set_enhanced_metrics_config( self, input: Option<EnhancedMetricsConfig>, ) -> Self

The enhancedMetricsConfig object.

Source

pub fn get_enhanced_metrics_config(&self) -> &Option<EnhancedMetricsConfig>

The enhancedMetricsConfig object.

Source

pub fn build(self) -> GraphqlApi

Consumes the builder and constructs a GraphqlApi.

Trait Implementations§

Source§

impl Clone for GraphqlApiBuilder

Source§

fn clone(&self) -> GraphqlApiBuilder

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 GraphqlApiBuilder

Source§

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

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

impl Default for GraphqlApiBuilder

Source§

fn default() -> GraphqlApiBuilder

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

impl PartialEq for GraphqlApiBuilder

Source§

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

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,