aws_sdk_databasemigration::types::builders

Struct ReplicationTaskBuilder

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

A builder for ReplicationTask.

Implementations§

Source§

impl ReplicationTaskBuilder

Source

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

The user-assigned replication task identifier or name.

Constraints:

  • Must contain 1-255 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Source

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

The user-assigned replication task identifier or name.

Constraints:

  • Must contain 1-255 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Source

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

The user-assigned replication task identifier or name.

Constraints:

  • Must contain 1-255 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Source

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

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

Source

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

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

Source

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

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

Source

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

The ARN that uniquely identifies the endpoint.

Source

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

The ARN that uniquely identifies the endpoint.

Source

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

The ARN that uniquely identifies the endpoint.

Source

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

The ARN of the replication instance.

Source

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

The ARN of the replication instance.

Source

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

The ARN of the replication instance.

Source

pub fn migration_type(self, input: MigrationTypeValue) -> Self

The type of migration.

Source

pub fn set_migration_type(self, input: Option<MigrationTypeValue>) -> Self

The type of migration.

Source

pub fn get_migration_type(&self) -> &Option<MigrationTypeValue>

The type of migration.

Source

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

Table mappings specified in the task.

Source

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

Table mappings specified in the task.

Source

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

Table mappings specified in the task.

Source

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

The settings for the replication task.

Source

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

The settings for the replication task.

Source

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

The settings for the replication task.

Source

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

The status of the replication task. This response parameter can return one of the following values:

Source

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

The status of the replication task. This response parameter can return one of the following values:

Source

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

The status of the replication task. This response parameter can return one of the following values:

Source

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

The last error (failure) message generated for the replication task.

Source

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

The last error (failure) message generated for the replication task.

Source

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

The last error (failure) message generated for the replication task.

Source

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

The reason the replication task was stopped. This response parameter can return one of the following values:

  • "Stop Reason NORMAL" – The task completed successfully with no additional information returned.

  • "Stop Reason RECOVERABLE_ERROR"

  • "Stop Reason FATAL_ERROR"

  • "Stop Reason FULL_LOAD_ONLY_FINISHED" – The task completed the full load phase. DMS applied cached changes if you set StopTaskCachedChangesApplied to true.

  • "Stop Reason STOPPED_AFTER_FULL_LOAD" – Full load completed, with cached changes not applied

  • "Stop Reason STOPPED_AFTER_CACHED_EVENTS" – Full load completed, with cached changes applied

  • "Stop Reason EXPRESS_LICENSE_LIMITS_REACHED"

  • "Stop Reason STOPPED_AFTER_DDL_APPLY" – User-defined stop task after DDL applied

  • "Stop Reason STOPPED_DUE_TO_LOW_MEMORY"

  • "Stop Reason STOPPED_DUE_TO_LOW_DISK"

  • "Stop Reason STOPPED_AT_SERVER_TIME" – User-defined server time for stopping task

  • "Stop Reason STOPPED_AT_COMMIT_TIME" – User-defined commit time for stopping task

  • "Stop Reason RECONFIGURATION_RESTART"

  • "Stop Reason RECYCLE_TASK"

Source

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

The reason the replication task was stopped. This response parameter can return one of the following values:

  • "Stop Reason NORMAL" – The task completed successfully with no additional information returned.

  • "Stop Reason RECOVERABLE_ERROR"

  • "Stop Reason FATAL_ERROR"

  • "Stop Reason FULL_LOAD_ONLY_FINISHED" – The task completed the full load phase. DMS applied cached changes if you set StopTaskCachedChangesApplied to true.

  • "Stop Reason STOPPED_AFTER_FULL_LOAD" – Full load completed, with cached changes not applied

  • "Stop Reason STOPPED_AFTER_CACHED_EVENTS" – Full load completed, with cached changes applied

  • "Stop Reason EXPRESS_LICENSE_LIMITS_REACHED"

  • "Stop Reason STOPPED_AFTER_DDL_APPLY" – User-defined stop task after DDL applied

  • "Stop Reason STOPPED_DUE_TO_LOW_MEMORY"

  • "Stop Reason STOPPED_DUE_TO_LOW_DISK"

  • "Stop Reason STOPPED_AT_SERVER_TIME" – User-defined server time for stopping task

  • "Stop Reason STOPPED_AT_COMMIT_TIME" – User-defined commit time for stopping task

  • "Stop Reason RECONFIGURATION_RESTART"

  • "Stop Reason RECYCLE_TASK"

Source

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

The reason the replication task was stopped. This response parameter can return one of the following values:

  • "Stop Reason NORMAL" – The task completed successfully with no additional information returned.

  • "Stop Reason RECOVERABLE_ERROR"

  • "Stop Reason FATAL_ERROR"

  • "Stop Reason FULL_LOAD_ONLY_FINISHED" – The task completed the full load phase. DMS applied cached changes if you set StopTaskCachedChangesApplied to true.

  • "Stop Reason STOPPED_AFTER_FULL_LOAD" – Full load completed, with cached changes not applied

  • "Stop Reason STOPPED_AFTER_CACHED_EVENTS" – Full load completed, with cached changes applied

  • "Stop Reason EXPRESS_LICENSE_LIMITS_REACHED"

  • "Stop Reason STOPPED_AFTER_DDL_APPLY" – User-defined stop task after DDL applied

  • "Stop Reason STOPPED_DUE_TO_LOW_MEMORY"

  • "Stop Reason STOPPED_DUE_TO_LOW_DISK"

  • "Stop Reason STOPPED_AT_SERVER_TIME" – User-defined server time for stopping task

  • "Stop Reason STOPPED_AT_COMMIT_TIME" – User-defined commit time for stopping task

  • "Stop Reason RECONFIGURATION_RESTART"

  • "Stop Reason RECYCLE_TASK"

Source

pub fn replication_task_creation_date(self, input: DateTime) -> Self

The date the replication task was created.

Source

pub fn set_replication_task_creation_date(self, input: Option<DateTime>) -> Self

The date the replication task was created.

Source

pub fn get_replication_task_creation_date(&self) -> &Option<DateTime>

The date the replication task was created.

Source

pub fn replication_task_start_date(self, input: DateTime) -> Self

The date the replication task is scheduled to start.

Source

pub fn set_replication_task_start_date(self, input: Option<DateTime>) -> Self

The date the replication task is scheduled to start.

Source

pub fn get_replication_task_start_date(&self) -> &Option<DateTime>

The date the replication task is scheduled to start.

Source

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

Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want the CDC operation to start. Specifying both values results in an error.

The value can be in date, checkpoint, or LSN/SCN format.

Date Example: --cdc-start-position “2018-03-08T12:12:12”

Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"

LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”

Source

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

Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want the CDC operation to start. Specifying both values results in an error.

The value can be in date, checkpoint, or LSN/SCN format.

Date Example: --cdc-start-position “2018-03-08T12:12:12”

Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"

LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”

Source

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

Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want the CDC operation to start. Specifying both values results in an error.

The value can be in date, checkpoint, or LSN/SCN format.

Date Example: --cdc-start-position “2018-03-08T12:12:12”

Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"

LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”

Source

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

Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.

Server time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”

Commit time example: --cdc-stop-position “commit_time:2018-02-09T12:12:12“

Source

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

Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.

Server time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”

Commit time example: --cdc-stop-position “commit_time:2018-02-09T12:12:12“

Source

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

Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.

Server time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”

Commit time example: --cdc-stop-position “commit_time:2018-02-09T12:12:12“

Source

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

Indicates the last checkpoint that occurred during a change data capture (CDC) operation. You can provide this value to the CdcStartPosition parameter to start a CDC operation that begins at that checkpoint.

Source

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

Indicates the last checkpoint that occurred during a change data capture (CDC) operation. You can provide this value to the CdcStartPosition parameter to start a CDC operation that begins at that checkpoint.

Source

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

Indicates the last checkpoint that occurred during a change data capture (CDC) operation. You can provide this value to the CdcStartPosition parameter to start a CDC operation that begins at that checkpoint.

Source

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

The Amazon Resource Name (ARN) of the replication task.

Source

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

The Amazon Resource Name (ARN) of the replication task.

Source

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

The Amazon Resource Name (ARN) of the replication task.

Source

pub fn replication_task_stats(self, input: ReplicationTaskStats) -> Self

The statistics for the task, including elapsed time, tables loaded, and table errors.

Source

pub fn set_replication_task_stats( self, input: Option<ReplicationTaskStats>, ) -> Self

The statistics for the task, including elapsed time, tables loaded, and table errors.

Source

pub fn get_replication_task_stats(&self) -> &Option<ReplicationTaskStats>

The statistics for the task, including elapsed time, tables loaded, and table errors.

Source

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

Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the Database Migration Service User Guide.

Source

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

Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the Database Migration Service User Guide.

Source

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

Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the Database Migration Service User Guide.

Source

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

The ARN of the replication instance to which this task is moved in response to running the MoveReplicationTask operation. Otherwise, this response parameter isn't a member of the ReplicationTask object.

Source

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

The ARN of the replication instance to which this task is moved in response to running the MoveReplicationTask operation. Otherwise, this response parameter isn't a member of the ReplicationTask object.

Source

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

The ARN of the replication instance to which this task is moved in response to running the MoveReplicationTask operation. Otherwise, this response parameter isn't a member of the ReplicationTask object.

Source

pub fn build(self) -> ReplicationTask

Consumes the builder and constructs a ReplicationTask.

Trait Implementations§

Source§

impl Clone for ReplicationTaskBuilder

Source§

fn clone(&self) -> ReplicationTaskBuilder

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 ReplicationTaskBuilder

Source§

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

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

impl Default for ReplicationTaskBuilder

Source§

fn default() -> ReplicationTaskBuilder

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

impl PartialEq for ReplicationTaskBuilder

Source§

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

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