aws_sdk_databasemigration::types

Struct Endpoint

Source 
#[non_exhaustive]
pub struct Endpoint {
Show 36 fields
    pub endpoint_identifier: Option<String>,
    pub endpoint_type: Option<ReplicationEndpointTypeValue>,
    pub engine_name: Option<String>,
    pub engine_display_name: Option<String>,
    pub username: Option<String>,
    pub server_name: Option<String>,
    pub port: Option<i32>,
    pub database_name: Option<String>,
    pub extra_connection_attributes: Option<String>,
    pub status: Option<String>,
    pub kms_key_id: Option<String>,
    pub endpoint_arn: Option<String>,
    pub certificate_arn: Option<String>,
    pub ssl_mode: Option<DmsSslModeValue>,
    pub service_access_role_arn: Option<String>,
    pub external_table_definition: Option<String>,
    pub external_id: Option<String>,
    pub dynamo_db_settings: Option<DynamoDbSettings>,
    pub s3_settings: Option<S3Settings>,
    pub dms_transfer_settings: Option<DmsTransferSettings>,
    pub mongo_db_settings: Option<MongoDbSettings>,
    pub kinesis_settings: Option<KinesisSettings>,
    pub kafka_settings: Option<KafkaSettings>,
    pub elasticsearch_settings: Option<ElasticsearchSettings>,
    pub neptune_settings: Option<NeptuneSettings>,
    pub redshift_settings: Option<RedshiftSettings>,
    pub postgre_sql_settings: Option<PostgreSqlSettings>,
    pub my_sql_settings: Option<MySqlSettings>,
    pub oracle_settings: Option<OracleSettings>,
    pub sybase_settings: Option<SybaseSettings>,
    pub microsoft_sql_server_settings: Option<MicrosoftSqlServerSettings>,
    pub ibm_db2_settings: Option<IbmDb2Settings>,
    pub doc_db_settings: Option<DocDbSettings>,
    pub redis_settings: Option<RedisSettings>,
    pub gcp_my_sql_settings: Option<GcpMySqlSettings>,
    pub timestream_settings: Option<TimestreamSettings>,

}
Expand description

Describes an endpoint of a database instance in response to operations such as the following:

  • CreateEndpoint

  • DescribeEndpoint

  • ModifyEndpoint

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§endpoint_identifier: Option<String>

The database endpoint identifier. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two consecutive hyphens.

§endpoint_type: Option<ReplicationEndpointTypeValue>

The type of endpoint. Valid values are source and target.

§engine_name: Option<String>

The database engine name. Valid values, depending on the EndpointType, include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", "redshift", "redshift-serverless", "s3", "db2", "db2-zos", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "documentdb", "sqlserver", "neptune", and "babelfish".

§engine_display_name: Option<String>

The expanded name for the engine name. For example, if the EngineName parameter is "aurora", this value would be "Amazon Aurora MySQL".

§username: Option<String>

The user name used to connect to the endpoint.

§server_name: Option<String>

The name of the server at the endpoint.

§port: Option<i32>

The port value used to access the endpoint.

§database_name: Option<String>

The name of the database at the endpoint.

§extra_connection_attributes: Option<String>

Additional connection attributes used to connect to the endpoint.

§status: Option<String>

The status of the endpoint.

§kms_key_id: Option<String>

An KMS key identifier that is used to encrypt the connection parameters for the endpoint.

If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key.

KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.

§endpoint_arn: Option<String>

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

§certificate_arn: Option<String>

The Amazon Resource Name (ARN) used for SSL connection to the endpoint.

§ssl_mode: Option<DmsSslModeValue>

The SSL mode used to connect to the endpoint. The default value is none.

§service_access_role_arn: Option<String>

The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action.

§external_table_definition: Option<String>

The external table definition.

§external_id: Option<String>

Value returned by a call to CreateEndpoint that can be used for cross-account validation. Use it on a subsequent call to CreateEndpoint to create the endpoint with a cross-account.

§dynamo_db_settings: Option<DynamoDbSettings>

The settings for the DynamoDB target endpoint. For more information, see the DynamoDBSettings structure.

§s3_settings: Option<S3Settings>

The settings for the S3 target endpoint. For more information, see the S3Settings structure.

§dms_transfer_settings: Option<DmsTransferSettings>

The settings for the DMS Transfer type source. For more information, see the DmsTransferSettings structure.

§mongo_db_settings: Option<MongoDbSettings>

The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure.

§kinesis_settings: Option<KinesisSettings>

The settings for the Amazon Kinesis target endpoint. For more information, see the KinesisSettings structure.

§kafka_settings: Option<KafkaSettings>

The settings for the Apache Kafka target endpoint. For more information, see the KafkaSettings structure.

§elasticsearch_settings: Option<ElasticsearchSettings>

The settings for the OpenSearch source endpoint. For more information, see the ElasticsearchSettings structure.

§neptune_settings: Option<NeptuneSettings>

The settings for the Amazon Neptune target endpoint. For more information, see the NeptuneSettings structure.

§redshift_settings: Option<RedshiftSettings>

Settings for the Amazon Redshift endpoint.

§postgre_sql_settings: Option<PostgreSqlSettings>

The settings for the PostgreSQL source and target endpoint. For more information, see the PostgreSQLSettings structure.

§my_sql_settings: Option<MySqlSettings>

The settings for the MySQL source and target endpoint. For more information, see the MySQLSettings structure.

§oracle_settings: Option<OracleSettings>

The settings for the Oracle source and target endpoint. For more information, see the OracleSettings structure.

§sybase_settings: Option<SybaseSettings>

The settings for the SAP ASE source and target endpoint. For more information, see the SybaseSettings structure.

§microsoft_sql_server_settings: Option<MicrosoftSqlServerSettings>

The settings for the Microsoft SQL Server source and target endpoint. For more information, see the MicrosoftSQLServerSettings structure.

§ibm_db2_settings: Option<IbmDb2Settings>

The settings for the IBM Db2 LUW source endpoint. For more information, see the IBMDb2Settings structure.

§doc_db_settings: Option<DocDbSettings>

Provides information that defines a DocumentDB endpoint.

§redis_settings: Option<RedisSettings>

The settings for the Redis target endpoint. For more information, see the RedisSettings structure.

§gcp_my_sql_settings: Option<GcpMySqlSettings>

Settings in JSON format for the source GCP MySQL endpoint.

§timestream_settings: Option<TimestreamSettings>

The settings for the Amazon Timestream target endpoint. For more information, see the TimestreamSettings structure.

Implementations§

Source§

impl Endpoint

Source

pub fn endpoint_identifier(&self) -> Option<&str>

The database endpoint identifier. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two consecutive hyphens.

Source

pub fn endpoint_type(&self) -> Option<&ReplicationEndpointTypeValue>

The type of endpoint. Valid values are source and target.

Source

pub fn engine_name(&self) -> Option<&str>

The database engine name. Valid values, depending on the EndpointType, include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", "redshift", "redshift-serverless", "s3", "db2", "db2-zos", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "documentdb", "sqlserver", "neptune", and "babelfish".

Source

pub fn engine_display_name(&self) -> Option<&str>

The expanded name for the engine name. For example, if the EngineName parameter is "aurora", this value would be "Amazon Aurora MySQL".

Source

pub fn username(&self) -> Option<&str>

The user name used to connect to the endpoint.

Source

pub fn server_name(&self) -> Option<&str>

The name of the server at the endpoint.

Source

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

The port value used to access the endpoint.

Source

pub fn database_name(&self) -> Option<&str>

The name of the database at the endpoint.

Source

pub fn extra_connection_attributes(&self) -> Option<&str>

Additional connection attributes used to connect to the endpoint.

Source

pub fn status(&self) -> Option<&str>

The status of the endpoint.

Source

pub fn kms_key_id(&self) -> Option<&str>

An KMS key identifier that is used to encrypt the connection parameters for the endpoint.

If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key.

KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.

Source

pub fn endpoint_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

Source

pub fn certificate_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) used for SSL connection to the endpoint.

Source

pub fn ssl_mode(&self) -> Option<&DmsSslModeValue>

The SSL mode used to connect to the endpoint. The default value is none.

Source

pub fn service_access_role_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action.

Source

pub fn external_table_definition(&self) -> Option<&str>

The external table definition.

Source

pub fn external_id(&self) -> Option<&str>

Value returned by a call to CreateEndpoint that can be used for cross-account validation. Use it on a subsequent call to CreateEndpoint to create the endpoint with a cross-account.

Source

pub fn dynamo_db_settings(&self) -> Option<&DynamoDbSettings>

The settings for the DynamoDB target endpoint. For more information, see the DynamoDBSettings structure.

Source

pub fn s3_settings(&self) -> Option<&S3Settings>

The settings for the S3 target endpoint. For more information, see the S3Settings structure.

Source

pub fn dms_transfer_settings(&self) -> Option<&DmsTransferSettings>

The settings for the DMS Transfer type source. For more information, see the DmsTransferSettings structure.

Source

pub fn mongo_db_settings(&self) -> Option<&MongoDbSettings>

The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure.

Source

pub fn kinesis_settings(&self) -> Option<&KinesisSettings>

The settings for the Amazon Kinesis target endpoint. For more information, see the KinesisSettings structure.

Source

pub fn kafka_settings(&self) -> Option<&KafkaSettings>

The settings for the Apache Kafka target endpoint. For more information, see the KafkaSettings structure.

Source

pub fn elasticsearch_settings(&self) -> Option<&ElasticsearchSettings>

The settings for the OpenSearch source endpoint. For more information, see the ElasticsearchSettings structure.

Source

pub fn neptune_settings(&self) -> Option<&NeptuneSettings>

The settings for the Amazon Neptune target endpoint. For more information, see the NeptuneSettings structure.

Source

pub fn redshift_settings(&self) -> Option<&RedshiftSettings>

Settings for the Amazon Redshift endpoint.

Source

pub fn postgre_sql_settings(&self) -> Option<&PostgreSqlSettings>

The settings for the PostgreSQL source and target endpoint. For more information, see the PostgreSQLSettings structure.

Source

pub fn my_sql_settings(&self) -> Option<&MySqlSettings>

The settings for the MySQL source and target endpoint. For more information, see the MySQLSettings structure.

Source

pub fn oracle_settings(&self) -> Option<&OracleSettings>

The settings for the Oracle source and target endpoint. For more information, see the OracleSettings structure.

Source

pub fn sybase_settings(&self) -> Option<&SybaseSettings>

The settings for the SAP ASE source and target endpoint. For more information, see the SybaseSettings structure.

Source

pub fn microsoft_sql_server_settings( &self, ) -> Option<&MicrosoftSqlServerSettings>

The settings for the Microsoft SQL Server source and target endpoint. For more information, see the MicrosoftSQLServerSettings structure.

Source

pub fn ibm_db2_settings(&self) -> Option<&IbmDb2Settings>

The settings for the IBM Db2 LUW source endpoint. For more information, see the IBMDb2Settings structure.

Source

pub fn doc_db_settings(&self) -> Option<&DocDbSettings>

Provides information that defines a DocumentDB endpoint.

Source

pub fn redis_settings(&self) -> Option<&RedisSettings>

The settings for the Redis target endpoint. For more information, see the RedisSettings structure.

Source

pub fn gcp_my_sql_settings(&self) -> Option<&GcpMySqlSettings>

Settings in JSON format for the source GCP MySQL endpoint.

Source

pub fn timestream_settings(&self) -> Option<&TimestreamSettings>

The settings for the Amazon Timestream target endpoint. For more information, see the TimestreamSettings structure.

Source§

impl Endpoint

Source

pub fn builder() -> EndpointBuilder

Creates a new builder-style object to manufacture Endpoint.

Trait Implementations§

Source§

impl Clone for Endpoint

Source§

fn clone(&self) -> Endpoint

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 Endpoint

Source§

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

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

impl PartialEq for Endpoint

Source§

fn eq(&self, other: &Endpoint) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for Endpoint

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬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