Enum PutFileError

Source
#[non_exhaustive]
pub enum PutFileError {
Show 31 variants BranchDoesNotExistException(BranchDoesNotExistException), BranchNameIsTagNameException(BranchNameIsTagNameException), BranchNameRequiredException(BranchNameRequiredException), CommitMessageLengthExceededException(CommitMessageLengthExceededException), DirectoryNameConflictsWithFileNameException(DirectoryNameConflictsWithFileNameException), EncryptionIntegrityChecksFailedException(EncryptionIntegrityChecksFailedException), EncryptionKeyAccessDeniedException(EncryptionKeyAccessDeniedException), EncryptionKeyDisabledException(EncryptionKeyDisabledException), EncryptionKeyNotFoundException(EncryptionKeyNotFoundException), EncryptionKeyUnavailableException(EncryptionKeyUnavailableException), FileContentRequiredException(FileContentRequiredException), FileContentSizeLimitExceededException(FileContentSizeLimitExceededException), FileNameConflictsWithDirectoryNameException(FileNameConflictsWithDirectoryNameException), FilePathConflictsWithSubmodulePathException(FilePathConflictsWithSubmodulePathException), FolderContentSizeLimitExceededException(FolderContentSizeLimitExceededException), InvalidBranchNameException(InvalidBranchNameException), InvalidDeletionParameterException(InvalidDeletionParameterException), InvalidEmailException(InvalidEmailException), InvalidFileModeException(InvalidFileModeException), InvalidParentCommitIdException(InvalidParentCommitIdException), InvalidPathException(InvalidPathException), InvalidRepositoryNameException(InvalidRepositoryNameException), NameLengthExceededException(NameLengthExceededException), ParentCommitDoesNotExistException(ParentCommitDoesNotExistException), ParentCommitIdOutdatedException(ParentCommitIdOutdatedException), ParentCommitIdRequiredException(ParentCommitIdRequiredException), PathRequiredException(PathRequiredException), RepositoryDoesNotExistException(RepositoryDoesNotExistException), RepositoryNameRequiredException(RepositoryNameRequiredException), SameFileContentException(SameFileContentException), Unhandled(Unhandled),
}
Expand description

Error type for the PutFileError 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.
§

BranchDoesNotExistException(BranchDoesNotExistException)

The specified branch does not exist.

§

BranchNameIsTagNameException(BranchNameIsTagNameException)

The specified branch name is not valid because it is a tag name. Enter the name of a branch in the repository. For a list of valid branch names, use ListBranches.

§

BranchNameRequiredException(BranchNameRequiredException)

A branch name is required, but was not specified.

§

CommitMessageLengthExceededException(CommitMessageLengthExceededException)

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

§

DirectoryNameConflictsWithFileNameException(DirectoryNameConflictsWithFileNameException)

A file cannot be added to the repository because the specified path name has the same name as a file that already exists in this repository. Either provide a different name for the file, or specify a different path for the file.

§

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.

§

FileContentRequiredException(FileContentRequiredException)

The file cannot be added because it is empty. Empty files cannot be added to the repository with this API.

§

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.

§

FileNameConflictsWithDirectoryNameException(FileNameConflictsWithDirectoryNameException)

A file cannot be added to the repository because the specified file name has the same name as a directory in this repository. Either provide another name for the file, or add the file in a directory that does not match the file name.

§

FilePathConflictsWithSubmodulePathException(FilePathConflictsWithSubmodulePathException)

The commit cannot be created because a specified file path points to a submodule. Verify that the destination files have valid file paths that do not point to a submodule.

§

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.

§

InvalidBranchNameException(InvalidBranchNameException)

The specified reference name is not valid.

§

InvalidDeletionParameterException(InvalidDeletionParameterException)

The specified deletion parameter 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.

§

InvalidParentCommitIdException(InvalidParentCommitIdException)

The parent commit ID is not valid. The commit ID cannot be empty, and must match the head commit ID for the branch of the repository where you want to add or update a file.

§

InvalidPathException(InvalidPathException)

The specified path 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.

§

NameLengthExceededException(NameLengthExceededException)

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

§

ParentCommitDoesNotExistException(ParentCommitDoesNotExistException)

The parent commit ID is not valid because it does not exist. The specified parent commit ID does not exist in the specified branch of the repository.

§

ParentCommitIdOutdatedException(ParentCommitIdOutdatedException)

The file could not be added because the provided parent commit ID is not the current tip of the specified branch. To view the full commit ID of the current head of the branch, use GetBranch.

§

ParentCommitIdRequiredException(ParentCommitIdRequiredException)

A parent commit ID is required. To view the full commit ID of a branch in a repository, use GetBranch or a Git command (for example, git pull or git log).

§

PathRequiredException(PathRequiredException)

The folderPath for a location cannot be null.

§

RepositoryDoesNotExistException(RepositoryDoesNotExistException)

The specified repository does not exist.

§

RepositoryNameRequiredException(RepositoryNameRequiredException)

A repository name is required, but was not specified.

§

SameFileContentException(SameFileContentException)

The file was not added or updated because the content of the file is exactly the same as the content of that file in the repository and branch that you specified.

§

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 PutFileError

Source

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

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

Source

pub fn generic(err: ErrorMetadata) -> Self

Creates the PutFileError::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_branch_does_not_exist_exception(&self) -> bool

Returns true if the error kind is PutFileError::BranchDoesNotExistException.

Source

pub fn is_branch_name_is_tag_name_exception(&self) -> bool

Returns true if the error kind is PutFileError::BranchNameIsTagNameException.

Source

pub fn is_branch_name_required_exception(&self) -> bool

Returns true if the error kind is PutFileError::BranchNameRequiredException.

Source

pub fn is_commit_message_length_exceeded_exception(&self) -> bool

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

Source

pub fn is_directory_name_conflicts_with_file_name_exception(&self) -> bool

Returns true if the error kind is PutFileError::DirectoryNameConflictsWithFileNameException.

Source

pub fn is_encryption_integrity_checks_failed_exception(&self) -> bool

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

Source

pub fn is_encryption_key_access_denied_exception(&self) -> bool

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

Source

pub fn is_encryption_key_disabled_exception(&self) -> bool

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

Source

pub fn is_encryption_key_not_found_exception(&self) -> bool

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

Source

pub fn is_encryption_key_unavailable_exception(&self) -> bool

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

Source

pub fn is_file_content_required_exception(&self) -> bool

Returns true if the error kind is PutFileError::FileContentRequiredException.

Source

pub fn is_file_content_size_limit_exceeded_exception(&self) -> bool

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

Source

pub fn is_file_name_conflicts_with_directory_name_exception(&self) -> bool

Returns true if the error kind is PutFileError::FileNameConflictsWithDirectoryNameException.

Source

pub fn is_file_path_conflicts_with_submodule_path_exception(&self) -> bool

Returns true if the error kind is PutFileError::FilePathConflictsWithSubmodulePathException.

Source

pub fn is_folder_content_size_limit_exceeded_exception(&self) -> bool

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

Source

pub fn is_invalid_branch_name_exception(&self) -> bool

Returns true if the error kind is PutFileError::InvalidBranchNameException.

Source

pub fn is_invalid_deletion_parameter_exception(&self) -> bool

Returns true if the error kind is PutFileError::InvalidDeletionParameterException.

Source

pub fn is_invalid_email_exception(&self) -> bool

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

Source

pub fn is_invalid_file_mode_exception(&self) -> bool

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

Source

pub fn is_invalid_parent_commit_id_exception(&self) -> bool

Returns true if the error kind is PutFileError::InvalidParentCommitIdException.

Source

pub fn is_invalid_path_exception(&self) -> bool

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

Source

pub fn is_invalid_repository_name_exception(&self) -> bool

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

Source

pub fn is_name_length_exceeded_exception(&self) -> bool

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

Source

pub fn is_parent_commit_does_not_exist_exception(&self) -> bool

Returns true if the error kind is PutFileError::ParentCommitDoesNotExistException.

Source

pub fn is_parent_commit_id_outdated_exception(&self) -> bool

Returns true if the error kind is PutFileError::ParentCommitIdOutdatedException.

Source

pub fn is_parent_commit_id_required_exception(&self) -> bool

Returns true if the error kind is PutFileError::ParentCommitIdRequiredException.

Source

pub fn is_path_required_exception(&self) -> bool

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

Source

pub fn is_repository_does_not_exist_exception(&self) -> bool

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

Source

pub fn is_repository_name_required_exception(&self) -> bool

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

Source

pub fn is_same_file_content_exception(&self) -> bool

Returns true if the error kind is PutFileError::SameFileContentException.

Trait Implementations§

Source§

impl CreateUnhandledError for PutFileError

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 PutFileError

Source§

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

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

impl Display for PutFileError

Source§

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

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

impl Error for PutFileError

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<PutFileError> for Error

Source§

fn from(err: PutFileError) -> Self

Converts to this type from the input type.
Source§

impl ProvideErrorKind for PutFileError

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 PutFileError

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 PutFileError

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,