Struct Client

Source
pub struct Client { /* private fields */ }
Expand description

Client for Redshift Serverless

Client for invoking operations on Redshift Serverless. Each operation on Redshift Serverless is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

§Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_redshiftserverless::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_redshiftserverless::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

§Using the Client

A client has a function for every operation that can be performed by the service. For example, the ConvertRecoveryPointToSnapshot operation has a Client::convert_recovery_point_to_snapshot, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.convert_recovery_point_to_snapshot()
    .recovery_point_id("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations§

Source§

impl Client

Source

pub fn convert_recovery_point_to_snapshot( &self, ) -> ConvertRecoveryPointToSnapshotFluentBuilder

Constructs a fluent builder for the ConvertRecoveryPointToSnapshot operation.

Source§

impl Client

Source

pub fn create_custom_domain_association( &self, ) -> CreateCustomDomainAssociationFluentBuilder

Constructs a fluent builder for the CreateCustomDomainAssociation operation.

Source§

impl Client

Source

pub fn create_endpoint_access(&self) -> CreateEndpointAccessFluentBuilder

Constructs a fluent builder for the CreateEndpointAccess operation.

Source§

impl Client

Source

pub fn create_namespace(&self) -> CreateNamespaceFluentBuilder

Constructs a fluent builder for the CreateNamespace operation.

Source§

impl Client

Source

pub fn create_reservation(&self) -> CreateReservationFluentBuilder

Constructs a fluent builder for the CreateReservation operation.

Source§

impl Client

Source

pub fn create_scheduled_action(&self) -> CreateScheduledActionFluentBuilder

Constructs a fluent builder for the CreateScheduledAction operation.

Source§

impl Client

Source

pub fn create_snapshot(&self) -> CreateSnapshotFluentBuilder

Constructs a fluent builder for the CreateSnapshot operation.

Source§

impl Client

Source

pub fn create_snapshot_copy_configuration( &self, ) -> CreateSnapshotCopyConfigurationFluentBuilder

Constructs a fluent builder for the CreateSnapshotCopyConfiguration operation.

Source§

impl Client

Source

pub fn create_usage_limit(&self) -> CreateUsageLimitFluentBuilder

Constructs a fluent builder for the CreateUsageLimit operation.

Source§

impl Client

Source

pub fn create_workgroup(&self) -> CreateWorkgroupFluentBuilder

Constructs a fluent builder for the CreateWorkgroup operation.

Source§

impl Client

Source

pub fn delete_custom_domain_association( &self, ) -> DeleteCustomDomainAssociationFluentBuilder

Constructs a fluent builder for the DeleteCustomDomainAssociation operation.

Source§

impl Client

Source

pub fn delete_endpoint_access(&self) -> DeleteEndpointAccessFluentBuilder

Constructs a fluent builder for the DeleteEndpointAccess operation.

Source§

impl Client

Source

pub fn delete_namespace(&self) -> DeleteNamespaceFluentBuilder

Constructs a fluent builder for the DeleteNamespace operation.

Source§

impl Client

Source

pub fn delete_resource_policy(&self) -> DeleteResourcePolicyFluentBuilder

Constructs a fluent builder for the DeleteResourcePolicy operation.

Source§

impl Client

Source

pub fn delete_scheduled_action(&self) -> DeleteScheduledActionFluentBuilder

Constructs a fluent builder for the DeleteScheduledAction operation.

Source§

impl Client

Source

pub fn delete_snapshot(&self) -> DeleteSnapshotFluentBuilder

Constructs a fluent builder for the DeleteSnapshot operation.

Source§

impl Client

Source

pub fn delete_snapshot_copy_configuration( &self, ) -> DeleteSnapshotCopyConfigurationFluentBuilder

Constructs a fluent builder for the DeleteSnapshotCopyConfiguration operation.

Source§

impl Client

Source

pub fn delete_usage_limit(&self) -> DeleteUsageLimitFluentBuilder

Constructs a fluent builder for the DeleteUsageLimit operation.

Source§

impl Client

Source

pub fn delete_workgroup(&self) -> DeleteWorkgroupFluentBuilder

Constructs a fluent builder for the DeleteWorkgroup operation.

Source§

impl Client

Source

pub fn get_credentials(&self) -> GetCredentialsFluentBuilder

Constructs a fluent builder for the GetCredentials operation.

Source§

impl Client

Source

pub fn get_custom_domain_association( &self, ) -> GetCustomDomainAssociationFluentBuilder

Constructs a fluent builder for the GetCustomDomainAssociation operation.

Source§

impl Client

Source

pub fn get_endpoint_access(&self) -> GetEndpointAccessFluentBuilder

Constructs a fluent builder for the GetEndpointAccess operation.

Source§

impl Client

Source

pub fn get_namespace(&self) -> GetNamespaceFluentBuilder

Constructs a fluent builder for the GetNamespace operation.

Source§

impl Client

Source

pub fn get_recovery_point(&self) -> GetRecoveryPointFluentBuilder

Constructs a fluent builder for the GetRecoveryPoint operation.

Source§

impl Client

Source

pub fn get_reservation(&self) -> GetReservationFluentBuilder

Constructs a fluent builder for the GetReservation operation.

Source§

impl Client

Source

pub fn get_reservation_offering(&self) -> GetReservationOfferingFluentBuilder

Constructs a fluent builder for the GetReservationOffering operation.

Source§

impl Client

Source

pub fn get_resource_policy(&self) -> GetResourcePolicyFluentBuilder

Constructs a fluent builder for the GetResourcePolicy operation.

Source§

impl Client

Source

pub fn get_scheduled_action(&self) -> GetScheduledActionFluentBuilder

Constructs a fluent builder for the GetScheduledAction operation.

Source§

impl Client

Source

pub fn get_snapshot(&self) -> GetSnapshotFluentBuilder

Constructs a fluent builder for the GetSnapshot operation.

Source§

impl Client

Source

pub fn get_table_restore_status(&self) -> GetTableRestoreStatusFluentBuilder

Constructs a fluent builder for the GetTableRestoreStatus operation.

Source§

impl Client

Source

pub fn get_track(&self) -> GetTrackFluentBuilder

Constructs a fluent builder for the GetTrack operation.

Source§

impl Client

Source

pub fn get_usage_limit(&self) -> GetUsageLimitFluentBuilder

Constructs a fluent builder for the GetUsageLimit operation.

Source§

impl Client

Source

pub fn get_workgroup(&self) -> GetWorkgroupFluentBuilder

Constructs a fluent builder for the GetWorkgroup operation.

Source§

impl Client

Source

pub fn list_custom_domain_associations( &self, ) -> ListCustomDomainAssociationsFluentBuilder

Constructs a fluent builder for the ListCustomDomainAssociations operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn list_endpoint_access(&self) -> ListEndpointAccessFluentBuilder

Constructs a fluent builder for the ListEndpointAccess operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn list_managed_workgroups(&self) -> ListManagedWorkgroupsFluentBuilder

Constructs a fluent builder for the ListManagedWorkgroups operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn list_namespaces(&self) -> ListNamespacesFluentBuilder

Constructs a fluent builder for the ListNamespaces operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn list_recovery_points(&self) -> ListRecoveryPointsFluentBuilder

Constructs a fluent builder for the ListRecoveryPoints operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn list_reservation_offerings( &self, ) -> ListReservationOfferingsFluentBuilder

Constructs a fluent builder for the ListReservationOfferings operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn list_reservations(&self) -> ListReservationsFluentBuilder

Constructs a fluent builder for the ListReservations operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn list_scheduled_actions(&self) -> ListScheduledActionsFluentBuilder

Constructs a fluent builder for the ListScheduledActions operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn list_snapshot_copy_configurations( &self, ) -> ListSnapshotCopyConfigurationsFluentBuilder

Constructs a fluent builder for the ListSnapshotCopyConfigurations operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn list_snapshots(&self) -> ListSnapshotsFluentBuilder

Constructs a fluent builder for the ListSnapshots operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn list_table_restore_status(&self) -> ListTableRestoreStatusFluentBuilder

Constructs a fluent builder for the ListTableRestoreStatus operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

Source§

impl Client

Source

pub fn list_tracks(&self) -> ListTracksFluentBuilder

Constructs a fluent builder for the ListTracks operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • next_token(impl Into<String>) / set_next_token(Option<String>):
      required: false

      If your initial ListTracksRequest operation returns a nextToken, you can include the returned nextToken in following ListTracksRequest operations, which returns results in the next page.


    • max_results(i32) / set_max_results(Option<i32>):
      required: false

      The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.


  • On success, responds with ListTracksOutput with field(s):
  • On failure, responds with SdkError<ListTracksError>
Source§

impl Client

Source

pub fn list_usage_limits(&self) -> ListUsageLimitsFluentBuilder

Constructs a fluent builder for the ListUsageLimits operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn list_workgroups(&self) -> ListWorkgroupsFluentBuilder

Constructs a fluent builder for the ListWorkgroups operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn put_resource_policy(&self) -> PutResourcePolicyFluentBuilder

Constructs a fluent builder for the PutResourcePolicy operation.

Source§

impl Client

Source

pub fn restore_from_recovery_point( &self, ) -> RestoreFromRecoveryPointFluentBuilder

Constructs a fluent builder for the RestoreFromRecoveryPoint operation.

Source§

impl Client

Source

pub fn restore_from_snapshot(&self) -> RestoreFromSnapshotFluentBuilder

Constructs a fluent builder for the RestoreFromSnapshot operation.

Source§

impl Client

Source

pub fn restore_table_from_recovery_point( &self, ) -> RestoreTableFromRecoveryPointFluentBuilder

Constructs a fluent builder for the RestoreTableFromRecoveryPoint operation.

Source§

impl Client

Source

pub fn restore_table_from_snapshot( &self, ) -> RestoreTableFromSnapshotFluentBuilder

Constructs a fluent builder for the RestoreTableFromSnapshot operation.

Source§

impl Client

Source

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

Source§

impl Client

Source

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

Source§

impl Client

Source

pub fn update_custom_domain_association( &self, ) -> UpdateCustomDomainAssociationFluentBuilder

Constructs a fluent builder for the UpdateCustomDomainAssociation operation.

Source§

impl Client

Source

pub fn update_endpoint_access(&self) -> UpdateEndpointAccessFluentBuilder

Constructs a fluent builder for the UpdateEndpointAccess operation.

Source§

impl Client

Source

pub fn update_namespace(&self) -> UpdateNamespaceFluentBuilder

Constructs a fluent builder for the UpdateNamespace operation.

Source§

impl Client

Source

pub fn update_scheduled_action(&self) -> UpdateScheduledActionFluentBuilder

Constructs a fluent builder for the UpdateScheduledAction operation.

Source§

impl Client

Source

pub fn update_snapshot(&self) -> UpdateSnapshotFluentBuilder

Constructs a fluent builder for the UpdateSnapshot operation.

Source§

impl Client

Source

pub fn update_snapshot_copy_configuration( &self, ) -> UpdateSnapshotCopyConfigurationFluentBuilder

Constructs a fluent builder for the UpdateSnapshotCopyConfiguration operation.

Source§

impl Client

Source

pub fn update_usage_limit(&self) -> UpdateUsageLimitFluentBuilder

Constructs a fluent builder for the UpdateUsageLimit operation.

Source§

impl Client

Source

pub fn update_workgroup(&self) -> UpdateWorkgroupFluentBuilder

Constructs a fluent builder for the UpdateWorkgroup operation.

Source§

impl Client

Source

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

§Panics

This method will panic in the following cases:

  • Retries or timeouts are enabled without a sleep_impl configured.
  • Identity caching is enabled without a sleep_impl and time_source configured.
  • No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

Source

pub fn config(&self) -> &Config

Returns the client’s configuration.

Source§

impl Client

Source

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

§Panics
  • This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
  • This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
  • This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations§

Source§

impl Clone for Client

Source§

fn clone(&self) -> Client

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 Client

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Client

§

impl !RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl !UnwindSafe for Client

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,