Struct Client

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

Client for AWS Greengrass

Client for invoking operations on AWS Greengrass. Each operation on AWS Greengrass 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_greengrass::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_greengrass::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 AssociateRoleToGroup operation has a Client::associate_role_to_group, 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.associate_role_to_group()
    .group_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 associate_role_to_group(&self) -> AssociateRoleToGroupFluentBuilder

Constructs a fluent builder for the AssociateRoleToGroup operation.

Source§

impl Client

Source

pub fn associate_service_role_to_account( &self, ) -> AssociateServiceRoleToAccountFluentBuilder

Constructs a fluent builder for the AssociateServiceRoleToAccount operation.

Source§

impl Client

Source

pub fn create_connector_definition( &self, ) -> CreateConnectorDefinitionFluentBuilder

Constructs a fluent builder for the CreateConnectorDefinition operation.

Source§

impl Client

Source

pub fn create_connector_definition_version( &self, ) -> CreateConnectorDefinitionVersionFluentBuilder

Constructs a fluent builder for the CreateConnectorDefinitionVersion operation.

Source§

impl Client

Source

pub fn create_core_definition(&self) -> CreateCoreDefinitionFluentBuilder

Constructs a fluent builder for the CreateCoreDefinition operation.

Source§

impl Client

Source

pub fn create_core_definition_version( &self, ) -> CreateCoreDefinitionVersionFluentBuilder

Constructs a fluent builder for the CreateCoreDefinitionVersion operation.

Source§

impl Client

Source

pub fn create_deployment(&self) -> CreateDeploymentFluentBuilder

Constructs a fluent builder for the CreateDeployment operation.

Source§

impl Client

Source

pub fn create_device_definition(&self) -> CreateDeviceDefinitionFluentBuilder

Constructs a fluent builder for the CreateDeviceDefinition operation.

Source§

impl Client

Source

pub fn create_device_definition_version( &self, ) -> CreateDeviceDefinitionVersionFluentBuilder

Constructs a fluent builder for the CreateDeviceDefinitionVersion operation.

Source§

impl Client

Source

pub fn create_function_definition( &self, ) -> CreateFunctionDefinitionFluentBuilder

Constructs a fluent builder for the CreateFunctionDefinition operation.

Source§

impl Client

Source

pub fn create_function_definition_version( &self, ) -> CreateFunctionDefinitionVersionFluentBuilder

Constructs a fluent builder for the CreateFunctionDefinitionVersion operation.

Source§

impl Client

Source

pub fn create_group(&self) -> CreateGroupFluentBuilder

Constructs a fluent builder for the CreateGroup operation.

Source§

impl Client

Source

pub fn create_group_certificate_authority( &self, ) -> CreateGroupCertificateAuthorityFluentBuilder

Constructs a fluent builder for the CreateGroupCertificateAuthority operation.

Source§

impl Client

Source

pub fn create_group_version(&self) -> CreateGroupVersionFluentBuilder

Constructs a fluent builder for the CreateGroupVersion operation.

Source§

impl Client

Source

pub fn create_logger_definition(&self) -> CreateLoggerDefinitionFluentBuilder

Constructs a fluent builder for the CreateLoggerDefinition operation.

Source§

impl Client

Source

pub fn create_logger_definition_version( &self, ) -> CreateLoggerDefinitionVersionFluentBuilder

Constructs a fluent builder for the CreateLoggerDefinitionVersion operation.

Source§

impl Client

Source

pub fn create_resource_definition( &self, ) -> CreateResourceDefinitionFluentBuilder

Constructs a fluent builder for the CreateResourceDefinition operation.

Source§

impl Client

Source

pub fn create_resource_definition_version( &self, ) -> CreateResourceDefinitionVersionFluentBuilder

Constructs a fluent builder for the CreateResourceDefinitionVersion operation.

Source§

impl Client

Source

pub fn create_software_update_job(&self) -> CreateSoftwareUpdateJobFluentBuilder

Constructs a fluent builder for the CreateSoftwareUpdateJob operation.

Source§

impl Client

Source

pub fn create_subscription_definition( &self, ) -> CreateSubscriptionDefinitionFluentBuilder

Constructs a fluent builder for the CreateSubscriptionDefinition operation.

Source§

impl Client

Source

pub fn create_subscription_definition_version( &self, ) -> CreateSubscriptionDefinitionVersionFluentBuilder

Constructs a fluent builder for the CreateSubscriptionDefinitionVersion operation.

Source§

impl Client

Source

pub fn delete_connector_definition( &self, ) -> DeleteConnectorDefinitionFluentBuilder

Constructs a fluent builder for the DeleteConnectorDefinition operation.

Source§

impl Client

Source

pub fn delete_core_definition(&self) -> DeleteCoreDefinitionFluentBuilder

Constructs a fluent builder for the DeleteCoreDefinition operation.

Source§

impl Client

Source

pub fn delete_device_definition(&self) -> DeleteDeviceDefinitionFluentBuilder

Constructs a fluent builder for the DeleteDeviceDefinition operation.

Source§

impl Client

Source

pub fn delete_function_definition( &self, ) -> DeleteFunctionDefinitionFluentBuilder

Constructs a fluent builder for the DeleteFunctionDefinition operation.

Source§

impl Client

Source

pub fn delete_group(&self) -> DeleteGroupFluentBuilder

Constructs a fluent builder for the DeleteGroup operation.

Source§

impl Client

Source

pub fn delete_logger_definition(&self) -> DeleteLoggerDefinitionFluentBuilder

Constructs a fluent builder for the DeleteLoggerDefinition operation.

Source§

impl Client

Source

pub fn delete_resource_definition( &self, ) -> DeleteResourceDefinitionFluentBuilder

Constructs a fluent builder for the DeleteResourceDefinition operation.

Source§

impl Client

Source

pub fn delete_subscription_definition( &self, ) -> DeleteSubscriptionDefinitionFluentBuilder

Constructs a fluent builder for the DeleteSubscriptionDefinition operation.

Source§

impl Client

Source

pub fn disassociate_role_from_group( &self, ) -> DisassociateRoleFromGroupFluentBuilder

Constructs a fluent builder for the DisassociateRoleFromGroup operation.

Source§

impl Client

Source

pub fn disassociate_service_role_from_account( &self, ) -> DisassociateServiceRoleFromAccountFluentBuilder

Constructs a fluent builder for the DisassociateServiceRoleFromAccount operation.

Source§

impl Client

Source

pub fn get_associated_role(&self) -> GetAssociatedRoleFluentBuilder

Constructs a fluent builder for the GetAssociatedRole operation.

Source§

impl Client

Source

pub fn get_bulk_deployment_status(&self) -> GetBulkDeploymentStatusFluentBuilder

Constructs a fluent builder for the GetBulkDeploymentStatus operation.

Source§

impl Client

Source

pub fn get_connectivity_info(&self) -> GetConnectivityInfoFluentBuilder

Constructs a fluent builder for the GetConnectivityInfo operation.

Source§

impl Client

Source

pub fn get_connector_definition(&self) -> GetConnectorDefinitionFluentBuilder

Constructs a fluent builder for the GetConnectorDefinition operation.

Source§

impl Client

Source

pub fn get_connector_definition_version( &self, ) -> GetConnectorDefinitionVersionFluentBuilder

Constructs a fluent builder for the GetConnectorDefinitionVersion operation.

Source§

impl Client

Source

pub fn get_core_definition(&self) -> GetCoreDefinitionFluentBuilder

Constructs a fluent builder for the GetCoreDefinition operation.

Source§

impl Client

Source

pub fn get_core_definition_version( &self, ) -> GetCoreDefinitionVersionFluentBuilder

Constructs a fluent builder for the GetCoreDefinitionVersion operation.

Source§

impl Client

Source

pub fn get_deployment_status(&self) -> GetDeploymentStatusFluentBuilder

Constructs a fluent builder for the GetDeploymentStatus operation.

Source§

impl Client

Source

pub fn get_device_definition(&self) -> GetDeviceDefinitionFluentBuilder

Constructs a fluent builder for the GetDeviceDefinition operation.

Source§

impl Client

Source

pub fn get_device_definition_version( &self, ) -> GetDeviceDefinitionVersionFluentBuilder

Constructs a fluent builder for the GetDeviceDefinitionVersion operation.

Source§

impl Client

Source

pub fn get_function_definition(&self) -> GetFunctionDefinitionFluentBuilder

Constructs a fluent builder for the GetFunctionDefinition operation.

Source§

impl Client

Source

pub fn get_function_definition_version( &self, ) -> GetFunctionDefinitionVersionFluentBuilder

Constructs a fluent builder for the GetFunctionDefinitionVersion operation.

Source§

impl Client

Source

pub fn get_group(&self) -> GetGroupFluentBuilder

Constructs a fluent builder for the GetGroup operation.

Source§

impl Client

Source

pub fn get_group_certificate_authority( &self, ) -> GetGroupCertificateAuthorityFluentBuilder

Constructs a fluent builder for the GetGroupCertificateAuthority operation.

Source§

impl Client

Source

pub fn get_group_certificate_configuration( &self, ) -> GetGroupCertificateConfigurationFluentBuilder

Constructs a fluent builder for the GetGroupCertificateConfiguration operation.

Source§

impl Client

Source

pub fn get_group_version(&self) -> GetGroupVersionFluentBuilder

Constructs a fluent builder for the GetGroupVersion operation.

Source§

impl Client

Source

pub fn get_logger_definition(&self) -> GetLoggerDefinitionFluentBuilder

Constructs a fluent builder for the GetLoggerDefinition operation.

Source§

impl Client

Source

pub fn get_logger_definition_version( &self, ) -> GetLoggerDefinitionVersionFluentBuilder

Constructs a fluent builder for the GetLoggerDefinitionVersion operation.

Source§

impl Client

Source

pub fn get_resource_definition(&self) -> GetResourceDefinitionFluentBuilder

Constructs a fluent builder for the GetResourceDefinition operation.

Source§

impl Client

Source

pub fn get_resource_definition_version( &self, ) -> GetResourceDefinitionVersionFluentBuilder

Constructs a fluent builder for the GetResourceDefinitionVersion operation.

Source§

impl Client

Source

pub fn get_service_role_for_account( &self, ) -> GetServiceRoleForAccountFluentBuilder

Constructs a fluent builder for the GetServiceRoleForAccount operation.

Source§

impl Client

Source

pub fn get_subscription_definition( &self, ) -> GetSubscriptionDefinitionFluentBuilder

Constructs a fluent builder for the GetSubscriptionDefinition operation.

Source§

impl Client

Source

pub fn get_subscription_definition_version( &self, ) -> GetSubscriptionDefinitionVersionFluentBuilder

Constructs a fluent builder for the GetSubscriptionDefinitionVersion operation.

Source§

impl Client

Source

pub fn get_thing_runtime_configuration( &self, ) -> GetThingRuntimeConfigurationFluentBuilder

Constructs a fluent builder for the GetThingRuntimeConfiguration operation.

Source§

impl Client

Source

pub fn list_bulk_deployment_detailed_reports( &self, ) -> ListBulkDeploymentDetailedReportsFluentBuilder

Constructs a fluent builder for the ListBulkDeploymentDetailedReports operation.

Source§

impl Client

Source

pub fn list_bulk_deployments(&self) -> ListBulkDeploymentsFluentBuilder

Constructs a fluent builder for the ListBulkDeployments operation.

Source§

impl Client

Source

pub fn list_connector_definition_versions( &self, ) -> ListConnectorDefinitionVersionsFluentBuilder

Constructs a fluent builder for the ListConnectorDefinitionVersions operation.

Source§

impl Client

Source

pub fn list_connector_definitions( &self, ) -> ListConnectorDefinitionsFluentBuilder

Constructs a fluent builder for the ListConnectorDefinitions operation.

Source§

impl Client

Source

pub fn list_core_definition_versions( &self, ) -> ListCoreDefinitionVersionsFluentBuilder

Constructs a fluent builder for the ListCoreDefinitionVersions operation.

Source§

impl Client

Source

pub fn list_core_definitions(&self) -> ListCoreDefinitionsFluentBuilder

Constructs a fluent builder for the ListCoreDefinitions operation.

Source§

impl Client

Source

pub fn list_deployments(&self) -> ListDeploymentsFluentBuilder

Constructs a fluent builder for the ListDeployments operation.

Source§

impl Client

Source

pub fn list_device_definition_versions( &self, ) -> ListDeviceDefinitionVersionsFluentBuilder

Constructs a fluent builder for the ListDeviceDefinitionVersions operation.

Source§

impl Client

Source

pub fn list_device_definitions(&self) -> ListDeviceDefinitionsFluentBuilder

Constructs a fluent builder for the ListDeviceDefinitions operation.

Source§

impl Client

Source

pub fn list_function_definition_versions( &self, ) -> ListFunctionDefinitionVersionsFluentBuilder

Constructs a fluent builder for the ListFunctionDefinitionVersions operation.

Source§

impl Client

Source

pub fn list_function_definitions(&self) -> ListFunctionDefinitionsFluentBuilder

Constructs a fluent builder for the ListFunctionDefinitions operation.

Source§

impl Client

Source

pub fn list_group_certificate_authorities( &self, ) -> ListGroupCertificateAuthoritiesFluentBuilder

Constructs a fluent builder for the ListGroupCertificateAuthorities operation.

Source§

impl Client

Source

pub fn list_group_versions(&self) -> ListGroupVersionsFluentBuilder

Constructs a fluent builder for the ListGroupVersions operation.

Source§

impl Client

Source

pub fn list_groups(&self) -> ListGroupsFluentBuilder

Constructs a fluent builder for the ListGroups operation.

Source§

impl Client

Source

pub fn list_logger_definition_versions( &self, ) -> ListLoggerDefinitionVersionsFluentBuilder

Constructs a fluent builder for the ListLoggerDefinitionVersions operation.

Source§

impl Client

Source

pub fn list_logger_definitions(&self) -> ListLoggerDefinitionsFluentBuilder

Constructs a fluent builder for the ListLoggerDefinitions operation.

Source§

impl Client

Source

pub fn list_resource_definition_versions( &self, ) -> ListResourceDefinitionVersionsFluentBuilder

Constructs a fluent builder for the ListResourceDefinitionVersions operation.

Source§

impl Client

Source

pub fn list_resource_definitions(&self) -> ListResourceDefinitionsFluentBuilder

Constructs a fluent builder for the ListResourceDefinitions operation.

Source§

impl Client

Source

pub fn list_subscription_definition_versions( &self, ) -> ListSubscriptionDefinitionVersionsFluentBuilder

Constructs a fluent builder for the ListSubscriptionDefinitionVersions operation.

Source§

impl Client

Source

pub fn list_subscription_definitions( &self, ) -> ListSubscriptionDefinitionsFluentBuilder

Constructs a fluent builder for the ListSubscriptionDefinitions operation.

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 reset_deployments(&self) -> ResetDeploymentsFluentBuilder

Constructs a fluent builder for the ResetDeployments operation.

Source§

impl Client

Source

pub fn start_bulk_deployment(&self) -> StartBulkDeploymentFluentBuilder

Constructs a fluent builder for the StartBulkDeployment operation.

Source§

impl Client

Source

pub fn stop_bulk_deployment(&self) -> StopBulkDeploymentFluentBuilder

Constructs a fluent builder for the StopBulkDeployment 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_connectivity_info(&self) -> UpdateConnectivityInfoFluentBuilder

Constructs a fluent builder for the UpdateConnectivityInfo operation.

Source§

impl Client

Source

pub fn update_connector_definition( &self, ) -> UpdateConnectorDefinitionFluentBuilder

Constructs a fluent builder for the UpdateConnectorDefinition operation.

Source§

impl Client

Source

pub fn update_core_definition(&self) -> UpdateCoreDefinitionFluentBuilder

Constructs a fluent builder for the UpdateCoreDefinition operation.

Source§

impl Client

Source

pub fn update_device_definition(&self) -> UpdateDeviceDefinitionFluentBuilder

Constructs a fluent builder for the UpdateDeviceDefinition operation.

Source§

impl Client

Source

pub fn update_function_definition( &self, ) -> UpdateFunctionDefinitionFluentBuilder

Constructs a fluent builder for the UpdateFunctionDefinition operation.

Source§

impl Client

Source

pub fn update_group(&self) -> UpdateGroupFluentBuilder

Constructs a fluent builder for the UpdateGroup operation.

Source§

impl Client

Source

pub fn update_group_certificate_configuration( &self, ) -> UpdateGroupCertificateConfigurationFluentBuilder

Constructs a fluent builder for the UpdateGroupCertificateConfiguration operation.

Source§

impl Client

Source

pub fn update_logger_definition(&self) -> UpdateLoggerDefinitionFluentBuilder

Constructs a fluent builder for the UpdateLoggerDefinition operation.

Source§

impl Client

Source

pub fn update_resource_definition( &self, ) -> UpdateResourceDefinitionFluentBuilder

Constructs a fluent builder for the UpdateResourceDefinition operation.

Source§

impl Client

Source

pub fn update_subscription_definition( &self, ) -> UpdateSubscriptionDefinitionFluentBuilder

Constructs a fluent builder for the UpdateSubscriptionDefinition operation.

Source§

impl Client

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,