#[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
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.
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)
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
impl PutFileError
Sourcepub fn unhandled(err: impl Into<Box<dyn Error + Send + Sync + 'static>>) -> Self
pub fn unhandled(err: impl Into<Box<dyn Error + Send + Sync + 'static>>) -> Self
Creates the PutFileError::Unhandled
variant from any error type.
Sourcepub fn generic(err: ErrorMetadata) -> Self
pub fn generic(err: ErrorMetadata) -> Self
Creates the PutFileError::Unhandled
variant from an ErrorMetadata
.
Sourcepub fn meta(&self) -> &ErrorMetadata
pub fn meta(&self) -> &ErrorMetadata
Returns error metadata, which includes the error code, message, request ID, and potentially additional information.
Sourcepub fn is_branch_does_not_exist_exception(&self) -> bool
pub fn is_branch_does_not_exist_exception(&self) -> bool
Returns true
if the error kind is PutFileError::BranchDoesNotExistException
.
Sourcepub fn is_branch_name_is_tag_name_exception(&self) -> bool
pub fn is_branch_name_is_tag_name_exception(&self) -> bool
Returns true
if the error kind is PutFileError::BranchNameIsTagNameException
.
Sourcepub fn is_branch_name_required_exception(&self) -> bool
pub fn is_branch_name_required_exception(&self) -> bool
Returns true
if the error kind is PutFileError::BranchNameRequiredException
.
Sourcepub fn is_commit_message_length_exceeded_exception(&self) -> bool
pub fn is_commit_message_length_exceeded_exception(&self) -> bool
Returns true
if the error kind is PutFileError::CommitMessageLengthExceededException
.
Sourcepub fn is_directory_name_conflicts_with_file_name_exception(&self) -> bool
pub fn is_directory_name_conflicts_with_file_name_exception(&self) -> bool
Returns true
if the error kind is PutFileError::DirectoryNameConflictsWithFileNameException
.
Sourcepub fn is_encryption_integrity_checks_failed_exception(&self) -> bool
pub fn is_encryption_integrity_checks_failed_exception(&self) -> bool
Returns true
if the error kind is PutFileError::EncryptionIntegrityChecksFailedException
.
Sourcepub fn is_encryption_key_access_denied_exception(&self) -> bool
pub fn is_encryption_key_access_denied_exception(&self) -> bool
Returns true
if the error kind is PutFileError::EncryptionKeyAccessDeniedException
.
Sourcepub fn is_encryption_key_disabled_exception(&self) -> bool
pub fn is_encryption_key_disabled_exception(&self) -> bool
Returns true
if the error kind is PutFileError::EncryptionKeyDisabledException
.
Sourcepub fn is_encryption_key_not_found_exception(&self) -> bool
pub fn is_encryption_key_not_found_exception(&self) -> bool
Returns true
if the error kind is PutFileError::EncryptionKeyNotFoundException
.
Returns true
if the error kind is PutFileError::EncryptionKeyUnavailableException
.
Sourcepub fn is_file_content_required_exception(&self) -> bool
pub fn is_file_content_required_exception(&self) -> bool
Returns true
if the error kind is PutFileError::FileContentRequiredException
.
Sourcepub fn is_file_content_size_limit_exceeded_exception(&self) -> bool
pub fn is_file_content_size_limit_exceeded_exception(&self) -> bool
Returns true
if the error kind is PutFileError::FileContentSizeLimitExceededException
.
Sourcepub fn is_file_name_conflicts_with_directory_name_exception(&self) -> bool
pub fn is_file_name_conflicts_with_directory_name_exception(&self) -> bool
Returns true
if the error kind is PutFileError::FileNameConflictsWithDirectoryNameException
.
Sourcepub fn is_file_path_conflicts_with_submodule_path_exception(&self) -> bool
pub fn is_file_path_conflicts_with_submodule_path_exception(&self) -> bool
Returns true
if the error kind is PutFileError::FilePathConflictsWithSubmodulePathException
.
Sourcepub fn is_folder_content_size_limit_exceeded_exception(&self) -> bool
pub fn is_folder_content_size_limit_exceeded_exception(&self) -> bool
Returns true
if the error kind is PutFileError::FolderContentSizeLimitExceededException
.
Sourcepub fn is_invalid_branch_name_exception(&self) -> bool
pub fn is_invalid_branch_name_exception(&self) -> bool
Returns true
if the error kind is PutFileError::InvalidBranchNameException
.
Sourcepub fn is_invalid_deletion_parameter_exception(&self) -> bool
pub fn is_invalid_deletion_parameter_exception(&self) -> bool
Returns true
if the error kind is PutFileError::InvalidDeletionParameterException
.
Sourcepub fn is_invalid_email_exception(&self) -> bool
pub fn is_invalid_email_exception(&self) -> bool
Returns true
if the error kind is PutFileError::InvalidEmailException
.
Sourcepub fn is_invalid_file_mode_exception(&self) -> bool
pub fn is_invalid_file_mode_exception(&self) -> bool
Returns true
if the error kind is PutFileError::InvalidFileModeException
.
Sourcepub fn is_invalid_parent_commit_id_exception(&self) -> bool
pub fn is_invalid_parent_commit_id_exception(&self) -> bool
Returns true
if the error kind is PutFileError::InvalidParentCommitIdException
.
Sourcepub fn is_invalid_path_exception(&self) -> bool
pub fn is_invalid_path_exception(&self) -> bool
Returns true
if the error kind is PutFileError::InvalidPathException
.
Sourcepub fn is_invalid_repository_name_exception(&self) -> bool
pub fn is_invalid_repository_name_exception(&self) -> bool
Returns true
if the error kind is PutFileError::InvalidRepositoryNameException
.
Sourcepub fn is_name_length_exceeded_exception(&self) -> bool
pub fn is_name_length_exceeded_exception(&self) -> bool
Returns true
if the error kind is PutFileError::NameLengthExceededException
.
Sourcepub fn is_parent_commit_does_not_exist_exception(&self) -> bool
pub fn is_parent_commit_does_not_exist_exception(&self) -> bool
Returns true
if the error kind is PutFileError::ParentCommitDoesNotExistException
.
Sourcepub fn is_parent_commit_id_outdated_exception(&self) -> bool
pub fn is_parent_commit_id_outdated_exception(&self) -> bool
Returns true
if the error kind is PutFileError::ParentCommitIdOutdatedException
.
Sourcepub fn is_parent_commit_id_required_exception(&self) -> bool
pub fn is_parent_commit_id_required_exception(&self) -> bool
Returns true
if the error kind is PutFileError::ParentCommitIdRequiredException
.
Sourcepub fn is_path_required_exception(&self) -> bool
pub fn is_path_required_exception(&self) -> bool
Returns true
if the error kind is PutFileError::PathRequiredException
.
Sourcepub fn is_repository_does_not_exist_exception(&self) -> bool
pub fn is_repository_does_not_exist_exception(&self) -> bool
Returns true
if the error kind is PutFileError::RepositoryDoesNotExistException
.
Sourcepub fn is_repository_name_required_exception(&self) -> bool
pub fn is_repository_name_required_exception(&self) -> bool
Returns true
if the error kind is PutFileError::RepositoryNameRequiredException
.
Sourcepub fn is_same_file_content_exception(&self) -> bool
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
impl CreateUnhandledError for PutFileError
Source§fn create_unhandled_error(
source: Box<dyn Error + Send + Sync + 'static>,
meta: Option<ErrorMetadata>,
) -> Self
fn create_unhandled_error( source: Box<dyn Error + Send + Sync + 'static>, meta: Option<ErrorMetadata>, ) -> Self
source
and error metadata.Source§impl Debug for PutFileError
impl Debug for PutFileError
Source§impl Display for PutFileError
impl Display for PutFileError
Source§impl Error for PutFileError
impl Error for PutFileError
Source§fn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
1.0.0 · Source§fn description(&self) -> &str
fn description(&self) -> &str
Source§impl From<PutFileError> for Error
impl From<PutFileError> for Error
Source§fn from(err: PutFileError) -> Self
fn from(err: PutFileError) -> Self
Source§impl ProvideErrorKind for PutFileError
impl ProvideErrorKind for PutFileError
Source§impl ProvideErrorMetadata for PutFileError
impl ProvideErrorMetadata for PutFileError
Source§fn meta(&self) -> &ErrorMetadata
fn meta(&self) -> &ErrorMetadata
Source§impl RequestId for PutFileError
impl RequestId for PutFileError
Source§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None
if the service could not be reached.Auto Trait Implementations§
impl Freeze for PutFileError
impl !RefUnwindSafe for PutFileError
impl Send for PutFileError
impl Sync for PutFileError
impl Unpin for PutFileError
impl !UnwindSafe for PutFileError
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
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 bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
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>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
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 rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
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 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.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
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);