Enum CreateUnreferencedMergeCommitError

Source
#[non_exhaustive]
pub enum CreateUnreferencedMergeCommitError {
Show 37 variants CommitDoesNotExistException(CommitDoesNotExistException), CommitMessageLengthExceededException(CommitMessageLengthExceededException), CommitRequiredException(CommitRequiredException), ConcurrentReferenceUpdateException(ConcurrentReferenceUpdateException), EncryptionIntegrityChecksFailedException(EncryptionIntegrityChecksFailedException), EncryptionKeyAccessDeniedException(EncryptionKeyAccessDeniedException), EncryptionKeyDisabledException(EncryptionKeyDisabledException), EncryptionKeyNotFoundException(EncryptionKeyNotFoundException), EncryptionKeyUnavailableException(EncryptionKeyUnavailableException), FileContentSizeLimitExceededException(FileContentSizeLimitExceededException), FileModeRequiredException(FileModeRequiredException), FolderContentSizeLimitExceededException(FolderContentSizeLimitExceededException), InvalidCommitException(InvalidCommitException), InvalidConflictDetailLevelException(InvalidConflictDetailLevelException), InvalidConflictResolutionException(InvalidConflictResolutionException), InvalidConflictResolutionStrategyException(InvalidConflictResolutionStrategyException), InvalidEmailException(InvalidEmailException), InvalidFileModeException(InvalidFileModeException), InvalidMergeOptionException(InvalidMergeOptionException), InvalidPathException(InvalidPathException), InvalidReplacementContentException(InvalidReplacementContentException), InvalidReplacementTypeException(InvalidReplacementTypeException), InvalidRepositoryNameException(InvalidRepositoryNameException), ManualMergeRequiredException(ManualMergeRequiredException), MaximumConflictResolutionEntriesExceededException(MaximumConflictResolutionEntriesExceededException), MaximumFileContentToLoadExceededException(MaximumFileContentToLoadExceededException), MaximumItemsToCompareExceededException(MaximumItemsToCompareExceededException), MergeOptionRequiredException(MergeOptionRequiredException), MultipleConflictResolutionEntriesException(MultipleConflictResolutionEntriesException), NameLengthExceededException(NameLengthExceededException), PathRequiredException(PathRequiredException), ReplacementContentRequiredException(ReplacementContentRequiredException), ReplacementTypeRequiredException(ReplacementTypeRequiredException), RepositoryDoesNotExistException(RepositoryDoesNotExistException), RepositoryNameRequiredException(RepositoryNameRequiredException), TipsDivergenceExceededException(TipsDivergenceExceededException), Unhandled(Unhandled),
}
Expand description

Error type for the CreateUnreferencedMergeCommitError operation.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

CommitDoesNotExistException(CommitDoesNotExistException)

The specified commit does not exist or no commit was specified, and the specified repository has no default branch.

§

CommitMessageLengthExceededException(CommitMessageLengthExceededException)

The commit message is too long. Provide a shorter string.

§

CommitRequiredException(CommitRequiredException)

A commit was not specified.

§

ConcurrentReferenceUpdateException(ConcurrentReferenceUpdateException)

The merge cannot be completed because the target branch has been modified. Another user might have modified the target branch while the merge was in progress. Wait a few minutes, and then try again.

§

EncryptionIntegrityChecksFailedException(EncryptionIntegrityChecksFailedException)

An encryption integrity check failed.

§

EncryptionKeyAccessDeniedException(EncryptionKeyAccessDeniedException)

An encryption key could not be accessed.

§

EncryptionKeyDisabledException(EncryptionKeyDisabledException)

The encryption key is disabled.

§

EncryptionKeyNotFoundException(EncryptionKeyNotFoundException)

No encryption key was found.

§

EncryptionKeyUnavailableException(EncryptionKeyUnavailableException)

The encryption key is not available.

§

FileContentSizeLimitExceededException(FileContentSizeLimitExceededException)

The file cannot be added because it is too large. The maximum file size is 6 MB, and the combined file content change size is 7 MB. Consider making these changes using a Git client.

§

FileModeRequiredException(FileModeRequiredException)

The commit cannot be created because no file mode has been specified. A file mode is required to update mode permissions for a file.

§

FolderContentSizeLimitExceededException(FolderContentSizeLimitExceededException)

The commit cannot be created because at least one of the overall changes in the commit results in a folder whose contents exceed the limit of 6 MB. Either reduce the number and size of your changes, or split the changes across multiple folders.

§

InvalidCommitException(InvalidCommitException)

The specified commit is not valid.

§

InvalidConflictDetailLevelException(InvalidConflictDetailLevelException)

The specified conflict detail level is not valid.

§

InvalidConflictResolutionException(InvalidConflictResolutionException)

The specified conflict resolution list is not valid.

§

InvalidConflictResolutionStrategyException(InvalidConflictResolutionStrategyException)

The specified conflict resolution strategy is not valid.

§

InvalidEmailException(InvalidEmailException)

The specified email address either contains one or more characters that are not allowed, or it exceeds the maximum number of characters allowed for an email address.

§

InvalidFileModeException(InvalidFileModeException)

The specified file mode permission is not valid. For a list of valid file mode permissions, see PutFile.

§

InvalidMergeOptionException(InvalidMergeOptionException)

The specified merge option is not valid for this operation. Not all merge strategies are supported for all operations.

§

InvalidPathException(InvalidPathException)

The specified path is not valid.

§

InvalidReplacementContentException(InvalidReplacementContentException)

Automerge was specified for resolving the conflict, but the replacement type is not valid or content is missing.

§

InvalidReplacementTypeException(InvalidReplacementTypeException)

Automerge was specified for resolving the conflict, but the specified replacement type is not valid.

§

InvalidRepositoryNameException(InvalidRepositoryNameException)

A specified repository name is not valid.

This exception occurs only when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.

§

ManualMergeRequiredException(ManualMergeRequiredException)

The pull request cannot be merged automatically into the destination branch. You must manually merge the branches and resolve any conflicts.

§

MaximumConflictResolutionEntriesExceededException(MaximumConflictResolutionEntriesExceededException)

The number of allowed conflict resolution entries was exceeded.

§

MaximumFileContentToLoadExceededException(MaximumFileContentToLoadExceededException)

The number of files to load exceeds the allowed limit.

§

MaximumItemsToCompareExceededException(MaximumItemsToCompareExceededException)

The number of items to compare between the source or destination branches and the merge base has exceeded the maximum allowed.

§

MergeOptionRequiredException(MergeOptionRequiredException)

A merge option or stategy is required, and none was provided.

§

MultipleConflictResolutionEntriesException(MultipleConflictResolutionEntriesException)

More than one conflict resolution entries exists for the conflict. A conflict can have only one conflict resolution entry.

§

NameLengthExceededException(NameLengthExceededException)

The user name is not valid because it has exceeded the character limit for author names.

§

PathRequiredException(PathRequiredException)

The folderPath for a location cannot be null.

§

ReplacementContentRequiredException(ReplacementContentRequiredException)

USE_NEW_CONTENT was specified, but no replacement content has been provided.

§

ReplacementTypeRequiredException(ReplacementTypeRequiredException)

A replacement type is required.

§

RepositoryDoesNotExistException(RepositoryDoesNotExistException)

The specified repository does not exist.

§

RepositoryNameRequiredException(RepositoryNameRequiredException)

A repository name is required, but was not specified.

§

TipsDivergenceExceededException(TipsDivergenceExceededException)

The divergence between the tips of the provided commit specifiers is too great to determine whether there might be any merge conflicts. Locally compare the specifiers using git diff or a diff tool.

§

Unhandled(Unhandled)

👎Deprecated: Matching Unhandled directly is not forwards compatible. Instead, match using a variable wildcard pattern and check .code():    err if err.code() == Some("SpecificExceptionCode") => { /* handle the error */ } See ProvideErrorMetadata for what information is available for the error.

An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).

Implementations§

Source§

impl CreateUnreferencedMergeCommitError

Source

pub fn unhandled(err: impl Into<Box<dyn Error + Send + Sync + 'static>>) -> Self

Creates the CreateUnreferencedMergeCommitError::Unhandled variant from any error type.

Source

pub fn generic(err: ErrorMetadata) -> Self

Creates the CreateUnreferencedMergeCommitError::Unhandled variant from an ErrorMetadata.

Source

pub fn meta(&self) -> &ErrorMetadata

Returns error metadata, which includes the error code, message, request ID, and potentially additional information.

Source

pub fn is_commit_does_not_exist_exception(&self) -> bool

Returns true if the error kind is CreateUnreferencedMergeCommitError::CommitDoesNotExistException.

Source

pub fn is_commit_message_length_exceeded_exception(&self) -> bool

Returns true if the error kind is CreateUnreferencedMergeCommitError::CommitMessageLengthExceededException.

Source

pub fn is_commit_required_exception(&self) -> bool

Returns true if the error kind is CreateUnreferencedMergeCommitError::CommitRequiredException.

Source

pub fn is_concurrent_reference_update_exception(&self) -> bool

Returns true if the error kind is CreateUnreferencedMergeCommitError::ConcurrentReferenceUpdateException.

Source

pub fn is_encryption_integrity_checks_failed_exception(&self) -> bool

Returns true if the error kind is CreateUnreferencedMergeCommitError::EncryptionIntegrityChecksFailedException.

Source

pub fn is_encryption_key_access_denied_exception(&self) -> bool

Returns true if the error kind is CreateUnreferencedMergeCommitError::EncryptionKeyAccessDeniedException.

Source

pub fn is_encryption_key_disabled_exception(&self) -> bool

Returns true if the error kind is CreateUnreferencedMergeCommitError::EncryptionKeyDisabledException.

Source

pub fn is_encryption_key_not_found_exception(&self) -> bool

Returns true if the error kind is CreateUnreferencedMergeCommitError::EncryptionKeyNotFoundException.

Source

pub fn is_encryption_key_unavailable_exception(&self) -> bool

Returns true if the error kind is CreateUnreferencedMergeCommitError::EncryptionKeyUnavailableException.

Source

pub fn is_file_content_size_limit_exceeded_exception(&self) -> bool

Returns true if the error kind is CreateUnreferencedMergeCommitError::FileContentSizeLimitExceededException.

Source

pub fn is_file_mode_required_exception(&self) -> bool

Returns true if the error kind is CreateUnreferencedMergeCommitError::FileModeRequiredException.

Source

pub fn is_folder_content_size_limit_exceeded_exception(&self) -> bool

Returns true if the error kind is CreateUnreferencedMergeCommitError::FolderContentSizeLimitExceededException.

Source

pub fn is_invalid_commit_exception(&self) -> bool

Returns true if the error kind is CreateUnreferencedMergeCommitError::InvalidCommitException.

Source

pub fn is_invalid_conflict_detail_level_exception(&self) -> bool

Returns true if the error kind is CreateUnreferencedMergeCommitError::InvalidConflictDetailLevelException.

Source

pub fn is_invalid_conflict_resolution_exception(&self) -> bool

Returns true if the error kind is CreateUnreferencedMergeCommitError::InvalidConflictResolutionException.

Source

pub fn is_invalid_conflict_resolution_strategy_exception(&self) -> bool

Returns true if the error kind is CreateUnreferencedMergeCommitError::InvalidConflictResolutionStrategyException.

Source

pub fn is_invalid_email_exception(&self) -> bool

Returns true if the error kind is CreateUnreferencedMergeCommitError::InvalidEmailException.

Source

pub fn is_invalid_file_mode_exception(&self) -> bool

Returns true if the error kind is CreateUnreferencedMergeCommitError::InvalidFileModeException.

Source

pub fn is_invalid_merge_option_exception(&self) -> bool

Returns true if the error kind is CreateUnreferencedMergeCommitError::InvalidMergeOptionException.

Source

pub fn is_invalid_path_exception(&self) -> bool

Returns true if the error kind is CreateUnreferencedMergeCommitError::InvalidPathException.

Source

pub fn is_invalid_replacement_content_exception(&self) -> bool

Returns true if the error kind is CreateUnreferencedMergeCommitError::InvalidReplacementContentException.

Source

pub fn is_invalid_replacement_type_exception(&self) -> bool

Returns true if the error kind is CreateUnreferencedMergeCommitError::InvalidReplacementTypeException.

Source

pub fn is_invalid_repository_name_exception(&self) -> bool

Returns true if the error kind is CreateUnreferencedMergeCommitError::InvalidRepositoryNameException.

Source

pub fn is_manual_merge_required_exception(&self) -> bool

Returns true if the error kind is CreateUnreferencedMergeCommitError::ManualMergeRequiredException.

Source

pub fn is_maximum_conflict_resolution_entries_exceeded_exception(&self) -> bool

Returns true if the error kind is CreateUnreferencedMergeCommitError::MaximumConflictResolutionEntriesExceededException.

Source

pub fn is_maximum_file_content_to_load_exceeded_exception(&self) -> bool

Returns true if the error kind is CreateUnreferencedMergeCommitError::MaximumFileContentToLoadExceededException.

Source

pub fn is_maximum_items_to_compare_exceeded_exception(&self) -> bool

Returns true if the error kind is CreateUnreferencedMergeCommitError::MaximumItemsToCompareExceededException.

Source

pub fn is_merge_option_required_exception(&self) -> bool

Returns true if the error kind is CreateUnreferencedMergeCommitError::MergeOptionRequiredException.

Source

pub fn is_multiple_conflict_resolution_entries_exception(&self) -> bool

Returns true if the error kind is CreateUnreferencedMergeCommitError::MultipleConflictResolutionEntriesException.

Source

pub fn is_name_length_exceeded_exception(&self) -> bool

Returns true if the error kind is CreateUnreferencedMergeCommitError::NameLengthExceededException.

Source

pub fn is_path_required_exception(&self) -> bool

Returns true if the error kind is CreateUnreferencedMergeCommitError::PathRequiredException.

Source

pub fn is_replacement_content_required_exception(&self) -> bool

Returns true if the error kind is CreateUnreferencedMergeCommitError::ReplacementContentRequiredException.

Source

pub fn is_replacement_type_required_exception(&self) -> bool

Returns true if the error kind is CreateUnreferencedMergeCommitError::ReplacementTypeRequiredException.

Source

pub fn is_repository_does_not_exist_exception(&self) -> bool

Returns true if the error kind is CreateUnreferencedMergeCommitError::RepositoryDoesNotExistException.

Source

pub fn is_repository_name_required_exception(&self) -> bool

Returns true if the error kind is CreateUnreferencedMergeCommitError::RepositoryNameRequiredException.

Source

pub fn is_tips_divergence_exceeded_exception(&self) -> bool

Returns true if the error kind is CreateUnreferencedMergeCommitError::TipsDivergenceExceededException.

Trait Implementations§

Source§

impl CreateUnhandledError for CreateUnreferencedMergeCommitError

Source§

fn create_unhandled_error( source: Box<dyn Error + Send + Sync + 'static>, meta: Option<ErrorMetadata>, ) -> Self

Creates an unhandled error variant with the given source and error metadata.
Source§

impl Debug for CreateUnreferencedMergeCommitError

Source§

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

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

impl Display for CreateUnreferencedMergeCommitError

Source§

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

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

impl Error for CreateUnreferencedMergeCommitError

Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
Source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type-based access to context intended for error reports. Read more
Source§

impl From<CreateUnreferencedMergeCommitError> for Error

Source§

fn from(err: CreateUnreferencedMergeCommitError) -> Self

Converts to this type from the input type.
Source§

impl ProvideErrorKind for CreateUnreferencedMergeCommitError

Source§

fn code(&self) -> Option<&str>

Returns the code for this error if one exists
Source§

fn retryable_error_kind(&self) -> Option<ErrorKind>

Returns the ErrorKind when the error is modeled as retryable Read more
Source§

impl ProvideErrorMetadata for CreateUnreferencedMergeCommitError

Source§

fn meta(&self) -> &ErrorMetadata

Returns error metadata, which includes the error code, message, request ID, and potentially additional information.
Source§

fn code(&self) -> Option<&str>

Returns the error code if it’s available.
Source§

fn message(&self) -> Option<&str>

Returns the error message, if there is one.
Source§

impl RequestId for CreateUnreferencedMergeCommitError

Source§

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

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> 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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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,