aws_sdk_workmail

Struct Client

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

Client for Amazon WorkMail

Client for invoking operations on Amazon WorkMail. Each operation on Amazon WorkMail 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_workmail::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_workmail::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 AssociateDelegateToResource operation has a Client::associate_delegate_to_resource, 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_delegate_to_resource()
    .organization_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_delegate_to_resource( &self, ) -> AssociateDelegateToResourceFluentBuilder

Constructs a fluent builder for the AssociateDelegateToResource operation.

Source§

impl Client

Source

pub fn associate_member_to_group(&self) -> AssociateMemberToGroupFluentBuilder

Constructs a fluent builder for the AssociateMemberToGroup operation.

Source§

impl Client

Source

pub fn assume_impersonation_role(&self) -> AssumeImpersonationRoleFluentBuilder

Constructs a fluent builder for the AssumeImpersonationRole operation.

Source§

impl Client

Source

pub fn cancel_mailbox_export_job(&self) -> CancelMailboxExportJobFluentBuilder

Constructs a fluent builder for the CancelMailboxExportJob operation.

Source§

impl Client

Source

pub fn create_alias(&self) -> CreateAliasFluentBuilder

Constructs a fluent builder for the CreateAlias operation.

Source§

impl Client

Source

pub fn create_availability_configuration( &self, ) -> CreateAvailabilityConfigurationFluentBuilder

Constructs a fluent builder for the CreateAvailabilityConfiguration 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_identity_center_application( &self, ) -> CreateIdentityCenterApplicationFluentBuilder

Constructs a fluent builder for the CreateIdentityCenterApplication operation.

Source§

impl Client

Source

pub fn create_impersonation_role(&self) -> CreateImpersonationRoleFluentBuilder

Constructs a fluent builder for the CreateImpersonationRole operation.

Source§

impl Client

Source

pub fn create_mobile_device_access_rule( &self, ) -> CreateMobileDeviceAccessRuleFluentBuilder

Constructs a fluent builder for the CreateMobileDeviceAccessRule operation.

Source§

impl Client

Source

pub fn create_organization(&self) -> CreateOrganizationFluentBuilder

Constructs a fluent builder for the CreateOrganization operation.

Source§

impl Client

Source

pub fn create_resource(&self) -> CreateResourceFluentBuilder

Constructs a fluent builder for the CreateResource operation.

Source§

impl Client

Source

pub fn create_user(&self) -> CreateUserFluentBuilder

Constructs a fluent builder for the CreateUser operation.

Source§

impl Client

Source

pub fn delete_access_control_rule(&self) -> DeleteAccessControlRuleFluentBuilder

Constructs a fluent builder for the DeleteAccessControlRule operation.

Source§

impl Client

Source

pub fn delete_alias(&self) -> DeleteAliasFluentBuilder

Constructs a fluent builder for the DeleteAlias operation.

Source§

impl Client

Source

pub fn delete_availability_configuration( &self, ) -> DeleteAvailabilityConfigurationFluentBuilder

Constructs a fluent builder for the DeleteAvailabilityConfiguration operation.

Source§

impl Client

Source

pub fn delete_email_monitoring_configuration( &self, ) -> DeleteEmailMonitoringConfigurationFluentBuilder

Constructs a fluent builder for the DeleteEmailMonitoringConfiguration 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_identity_center_application( &self, ) -> DeleteIdentityCenterApplicationFluentBuilder

Constructs a fluent builder for the DeleteIdentityCenterApplication operation.

Source§

impl Client

Source

pub fn delete_identity_provider_configuration( &self, ) -> DeleteIdentityProviderConfigurationFluentBuilder

Constructs a fluent builder for the DeleteIdentityProviderConfiguration operation.

Source§

impl Client

Source

pub fn delete_impersonation_role(&self) -> DeleteImpersonationRoleFluentBuilder

Constructs a fluent builder for the DeleteImpersonationRole operation.

Source§

impl Client

Source

pub fn delete_mailbox_permissions( &self, ) -> DeleteMailboxPermissionsFluentBuilder

Constructs a fluent builder for the DeleteMailboxPermissions operation.

Source§

impl Client

Source

pub fn delete_mobile_device_access_override( &self, ) -> DeleteMobileDeviceAccessOverrideFluentBuilder

Constructs a fluent builder for the DeleteMobileDeviceAccessOverride operation.

Source§

impl Client

Source

pub fn delete_mobile_device_access_rule( &self, ) -> DeleteMobileDeviceAccessRuleFluentBuilder

Constructs a fluent builder for the DeleteMobileDeviceAccessRule operation.

Source§

impl Client

Source

pub fn delete_organization(&self) -> DeleteOrganizationFluentBuilder

Constructs a fluent builder for the DeleteOrganization operation.

Source§

impl Client

Source

pub fn delete_personal_access_token( &self, ) -> DeletePersonalAccessTokenFluentBuilder

Constructs a fluent builder for the DeletePersonalAccessToken operation.

Source§

impl Client

Source

pub fn delete_resource(&self) -> DeleteResourceFluentBuilder

Constructs a fluent builder for the DeleteResource operation.

Source§

impl Client

Source

pub fn delete_retention_policy(&self) -> DeleteRetentionPolicyFluentBuilder

Constructs a fluent builder for the DeleteRetentionPolicy operation.

Source§

impl Client

Source

pub fn delete_user(&self) -> DeleteUserFluentBuilder

Constructs a fluent builder for the DeleteUser operation.

Source§

impl Client

Source

pub fn deregister_from_work_mail(&self) -> DeregisterFromWorkMailFluentBuilder

Constructs a fluent builder for the DeregisterFromWorkMail operation.

Source§

impl Client

Source

pub fn deregister_mail_domain(&self) -> DeregisterMailDomainFluentBuilder

Constructs a fluent builder for the DeregisterMailDomain operation.

Source§

impl Client

Source

pub fn describe_email_monitoring_configuration( &self, ) -> DescribeEmailMonitoringConfigurationFluentBuilder

Constructs a fluent builder for the DescribeEmailMonitoringConfiguration operation.

Source§

impl Client

Source

pub fn describe_entity(&self) -> DescribeEntityFluentBuilder

Constructs a fluent builder for the DescribeEntity operation.

Source§

impl Client

Source

pub fn describe_group(&self) -> DescribeGroupFluentBuilder

Constructs a fluent builder for the DescribeGroup operation.

Source§

impl Client

Source

pub fn describe_identity_provider_configuration( &self, ) -> DescribeIdentityProviderConfigurationFluentBuilder

Constructs a fluent builder for the DescribeIdentityProviderConfiguration operation.

Source§

impl Client

Source

pub fn describe_inbound_dmarc_settings( &self, ) -> DescribeInboundDmarcSettingsFluentBuilder

Constructs a fluent builder for the DescribeInboundDmarcSettings operation.

Source§

impl Client

Source

pub fn describe_mailbox_export_job( &self, ) -> DescribeMailboxExportJobFluentBuilder

Constructs a fluent builder for the DescribeMailboxExportJob operation.

Source§

impl Client

Source

pub fn describe_organization(&self) -> DescribeOrganizationFluentBuilder

Constructs a fluent builder for the DescribeOrganization operation.

Source§

impl Client

Source

pub fn describe_resource(&self) -> DescribeResourceFluentBuilder

Constructs a fluent builder for the DescribeResource operation.

Source§

impl Client

Source

pub fn describe_user(&self) -> DescribeUserFluentBuilder

Constructs a fluent builder for the DescribeUser operation.

Source§

impl Client

Source

pub fn disassociate_delegate_from_resource( &self, ) -> DisassociateDelegateFromResourceFluentBuilder

Constructs a fluent builder for the DisassociateDelegateFromResource operation.

Source§

impl Client

Source

pub fn disassociate_member_from_group( &self, ) -> DisassociateMemberFromGroupFluentBuilder

Constructs a fluent builder for the DisassociateMemberFromGroup operation.

Source§

impl Client

Source

pub fn get_access_control_effect(&self) -> GetAccessControlEffectFluentBuilder

Constructs a fluent builder for the GetAccessControlEffect operation.

Source§

impl Client

Source

pub fn get_default_retention_policy( &self, ) -> GetDefaultRetentionPolicyFluentBuilder

Constructs a fluent builder for the GetDefaultRetentionPolicy operation.

Source§

impl Client

Source

pub fn get_impersonation_role(&self) -> GetImpersonationRoleFluentBuilder

Constructs a fluent builder for the GetImpersonationRole operation.

Source§

impl Client

Source

pub fn get_impersonation_role_effect( &self, ) -> GetImpersonationRoleEffectFluentBuilder

Constructs a fluent builder for the GetImpersonationRoleEffect operation.

Source§

impl Client

Source

pub fn get_mail_domain(&self) -> GetMailDomainFluentBuilder

Constructs a fluent builder for the GetMailDomain operation.

Source§

impl Client

Source

pub fn get_mailbox_details(&self) -> GetMailboxDetailsFluentBuilder

Constructs a fluent builder for the GetMailboxDetails operation.

Source§

impl Client

Source

pub fn get_mobile_device_access_effect( &self, ) -> GetMobileDeviceAccessEffectFluentBuilder

Constructs a fluent builder for the GetMobileDeviceAccessEffect operation.

Source§

impl Client

Source

pub fn get_mobile_device_access_override( &self, ) -> GetMobileDeviceAccessOverrideFluentBuilder

Constructs a fluent builder for the GetMobileDeviceAccessOverride operation.

Source§

impl Client

Source

pub fn get_personal_access_token_metadata( &self, ) -> GetPersonalAccessTokenMetadataFluentBuilder

Constructs a fluent builder for the GetPersonalAccessTokenMetadata operation.

Source§

impl Client

Source

pub fn list_access_control_rules(&self) -> ListAccessControlRulesFluentBuilder

Constructs a fluent builder for the ListAccessControlRules operation.

Source§

impl Client

Source

pub fn list_aliases(&self) -> ListAliasesFluentBuilder

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

Source§

impl Client

Source

pub fn list_availability_configurations( &self, ) -> ListAvailabilityConfigurationsFluentBuilder

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

Source§

impl Client

Source

pub fn list_group_members(&self) -> ListGroupMembersFluentBuilder

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

Source§

impl Client

Source

pub fn list_groups(&self) -> ListGroupsFluentBuilder

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

Source§

impl Client

Source

pub fn list_groups_for_entity(&self) -> ListGroupsForEntityFluentBuilder

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

Source§

impl Client

Source

pub fn list_impersonation_roles(&self) -> ListImpersonationRolesFluentBuilder

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

Source§

impl Client

Source

pub fn list_mail_domains(&self) -> ListMailDomainsFluentBuilder

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

Source§

impl Client

Source

pub fn list_mailbox_export_jobs(&self) -> ListMailboxExportJobsFluentBuilder

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

Source§

impl Client

Source

pub fn list_mailbox_permissions(&self) -> ListMailboxPermissionsFluentBuilder

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

Source§

impl Client

Source

pub fn list_mobile_device_access_overrides( &self, ) -> ListMobileDeviceAccessOverridesFluentBuilder

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

Source§

impl Client

Source

pub fn list_mobile_device_access_rules( &self, ) -> ListMobileDeviceAccessRulesFluentBuilder

Constructs a fluent builder for the ListMobileDeviceAccessRules operation.

Source§

impl Client

Source

pub fn list_organizations(&self) -> ListOrganizationsFluentBuilder

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

Source§

impl Client

Source

pub fn list_personal_access_tokens( &self, ) -> ListPersonalAccessTokensFluentBuilder

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

Source§

impl Client

Source

pub fn list_resource_delegates(&self) -> ListResourceDelegatesFluentBuilder

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

Source§

impl Client

Source

pub fn list_resources(&self) -> ListResourcesFluentBuilder

Constructs a fluent builder for the ListResources 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_users(&self) -> ListUsersFluentBuilder

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

Source§

impl Client

Source

pub fn put_access_control_rule(&self) -> PutAccessControlRuleFluentBuilder

Constructs a fluent builder for the PutAccessControlRule operation.

Source§

impl Client

Source

pub fn put_email_monitoring_configuration( &self, ) -> PutEmailMonitoringConfigurationFluentBuilder

Constructs a fluent builder for the PutEmailMonitoringConfiguration operation.

Source§

impl Client

Source§

impl Client

Source

pub fn put_inbound_dmarc_settings(&self) -> PutInboundDmarcSettingsFluentBuilder

Constructs a fluent builder for the PutInboundDmarcSettings operation.

Source§

impl Client

Source

pub fn put_mailbox_permissions(&self) -> PutMailboxPermissionsFluentBuilder

Constructs a fluent builder for the PutMailboxPermissions operation.

  • The fluent builder is configurable:
    • organization_id(impl Into<String>) / set_organization_id(Option<String>):
      required: true

      The identifier of the organization under which the user, group, or resource exists.


    • entity_id(impl Into<String>) / set_entity_id(Option<String>):
      required: true

      The identifier of the user or resource for which to update mailbox permissions.

      The identifier can be UserId, ResourceID, or Group Id, Username, Resourcename, or Groupname, or email.

      • Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234

      • Email address: entity@domain.tld

      • Entity name: entity


    • grantee_id(impl Into<String>) / set_grantee_id(Option<String>):
      required: true

      The identifier of the user, group, or resource to which to grant the permissions.

      The identifier can be UserId, ResourceID, or Group Id, Username, Resourcename, or Groupname, or email.

      • Grantee ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234

      • Email address: grantee@domain.tld

      • Grantee name: grantee


    • permission_values(PermissionType) / set_permission_values(Option<Vec::<PermissionType>>):
      required: true

      The permissions granted to the grantee. SEND_AS allows the grantee to send email as the owner of the mailbox (the grantee is not mentioned on these emails). SEND_ON_BEHALF allows the grantee to send email on behalf of the owner of the mailbox (the grantee is not mentioned as the physical sender of these emails). FULL_ACCESS allows the grantee full access to the mailbox, irrespective of other folder-level permissions set on the mailbox.


  • On success, responds with PutMailboxPermissionsOutput
  • On failure, responds with SdkError<PutMailboxPermissionsError>
Source§

impl Client

Source

pub fn put_mobile_device_access_override( &self, ) -> PutMobileDeviceAccessOverrideFluentBuilder

Constructs a fluent builder for the PutMobileDeviceAccessOverride operation.

Source§

impl Client

Source

pub fn put_retention_policy(&self) -> PutRetentionPolicyFluentBuilder

Constructs a fluent builder for the PutRetentionPolicy operation.

Source§

impl Client

Source

pub fn register_mail_domain(&self) -> RegisterMailDomainFluentBuilder

Constructs a fluent builder for the RegisterMailDomain operation.

Source§

impl Client

Source

pub fn register_to_work_mail(&self) -> RegisterToWorkMailFluentBuilder

Constructs a fluent builder for the RegisterToWorkMail operation.

Source§

impl Client

Source

pub fn reset_password(&self) -> ResetPasswordFluentBuilder

Constructs a fluent builder for the ResetPassword operation.

Source§

impl Client

Source

pub fn start_mailbox_export_job(&self) -> StartMailboxExportJobFluentBuilder

Constructs a fluent builder for the StartMailboxExportJob 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 test_availability_configuration( &self, ) -> TestAvailabilityConfigurationFluentBuilder

Constructs a fluent builder for the TestAvailabilityConfiguration 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_availability_configuration( &self, ) -> UpdateAvailabilityConfigurationFluentBuilder

Constructs a fluent builder for the UpdateAvailabilityConfiguration operation.

Source§

impl Client

Source

pub fn update_default_mail_domain(&self) -> UpdateDefaultMailDomainFluentBuilder

Constructs a fluent builder for the UpdateDefaultMailDomain 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_impersonation_role(&self) -> UpdateImpersonationRoleFluentBuilder

Constructs a fluent builder for the UpdateImpersonationRole operation.

Source§

impl Client

Source

pub fn update_mailbox_quota(&self) -> UpdateMailboxQuotaFluentBuilder

Constructs a fluent builder for the UpdateMailboxQuota operation.

Source§

impl Client

Source

pub fn update_mobile_device_access_rule( &self, ) -> UpdateMobileDeviceAccessRuleFluentBuilder

Constructs a fluent builder for the UpdateMobileDeviceAccessRule operation.

Source§

impl Client

Source

pub fn update_primary_email_address( &self, ) -> UpdatePrimaryEmailAddressFluentBuilder

Constructs a fluent builder for the UpdatePrimaryEmailAddress operation.

Source§

impl Client

Source

pub fn update_resource(&self) -> UpdateResourceFluentBuilder

Constructs a fluent builder for the UpdateResource operation.

Source§

impl Client

Source

pub fn update_user(&self) -> UpdateUserFluentBuilder

Constructs a fluent builder for the UpdateUser 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 copy 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, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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,

Source§

impl<T> MaybeSendSync for T