#[non_exhaustive]pub enum CreatePullRequestError {
Show 26 variants
ClientRequestTokenRequiredException(ClientRequestTokenRequiredException),
EncryptionIntegrityChecksFailedException(EncryptionIntegrityChecksFailedException),
EncryptionKeyAccessDeniedException(EncryptionKeyAccessDeniedException),
EncryptionKeyDisabledException(EncryptionKeyDisabledException),
EncryptionKeyNotFoundException(EncryptionKeyNotFoundException),
EncryptionKeyUnavailableException(EncryptionKeyUnavailableException),
IdempotencyParameterMismatchException(IdempotencyParameterMismatchException),
InvalidClientRequestTokenException(InvalidClientRequestTokenException),
InvalidDescriptionException(InvalidDescriptionException),
InvalidReferenceNameException(InvalidReferenceNameException),
InvalidRepositoryNameException(InvalidRepositoryNameException),
InvalidTargetException(InvalidTargetException),
InvalidTargetsException(InvalidTargetsException),
InvalidTitleException(InvalidTitleException),
MaximumOpenPullRequestsExceededException(MaximumOpenPullRequestsExceededException),
MultipleRepositoriesInPullRequestException(MultipleRepositoriesInPullRequestException),
ReferenceDoesNotExistException(ReferenceDoesNotExistException),
ReferenceNameRequiredException(ReferenceNameRequiredException),
ReferenceTypeNotSupportedException(ReferenceTypeNotSupportedException),
RepositoryDoesNotExistException(RepositoryDoesNotExistException),
RepositoryNameRequiredException(RepositoryNameRequiredException),
SourceAndDestinationAreSameException(SourceAndDestinationAreSameException),
TargetRequiredException(TargetRequiredException),
TargetsRequiredException(TargetsRequiredException),
TitleRequiredException(TitleRequiredException),
Unhandled(Unhandled),
}
Expand description
Error type for the CreatePullRequestError
operation.
Variants (Non-exhaustive)§
This enum is marked as non-exhaustive
ClientRequestTokenRequiredException(ClientRequestTokenRequiredException)
A client request token is required. A client request token is an unique, client-generated idempotency token that, when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is included, the request returns information about the initial request that used that token.
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.
IdempotencyParameterMismatchException(IdempotencyParameterMismatchException)
The client request token is not valid. Either the token is not in a valid format, or the token has been used in a previous request and cannot be reused.
InvalidClientRequestTokenException(InvalidClientRequestTokenException)
The client request token is not valid.
InvalidDescriptionException(InvalidDescriptionException)
The pull request description is not valid. Descriptions cannot be more than 1,000 characters.
InvalidReferenceNameException(InvalidReferenceNameException)
The specified reference name format is not valid. Reference names must conform to the Git references format (for example, refs/heads/main). For more information, see Git Internals - Git References or consult your Git documentation.
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.
InvalidTargetException(InvalidTargetException)
The target for the pull request is not valid. A target must contain the full values for the repository name, source branch, and destination branch for the pull request.
InvalidTargetsException(InvalidTargetsException)
The targets for the pull request is not valid or not in a valid format. Targets are a list of target objects. Each target object must contain the full values for the repository name, source branch, and destination branch for a pull request.
InvalidTitleException(InvalidTitleException)
The title of the pull request is not valid. Pull request titles cannot exceed 100 characters in length.
MaximumOpenPullRequestsExceededException(MaximumOpenPullRequestsExceededException)
You cannot create the pull request because the repository has too many open pull requests. The maximum number of open pull requests for a repository is 1,000. Close one or more open pull requests, and then try again.
MultipleRepositoriesInPullRequestException(MultipleRepositoriesInPullRequestException)
You cannot include more than one repository in a pull request. Make sure you have specified only one repository name in your request, and then try again.
ReferenceDoesNotExistException(ReferenceDoesNotExistException)
The specified reference does not exist. You must provide a full commit ID.
ReferenceNameRequiredException(ReferenceNameRequiredException)
A reference name is required, but none was provided.
ReferenceTypeNotSupportedException(ReferenceTypeNotSupportedException)
The specified reference is not a supported type.
RepositoryDoesNotExistException(RepositoryDoesNotExistException)
The specified repository does not exist.
RepositoryNameRequiredException(RepositoryNameRequiredException)
A repository name is required, but was not specified.
SourceAndDestinationAreSameException(SourceAndDestinationAreSameException)
The source branch and destination branch for the pull request are the same. You must specify different branches for the source and destination.
TargetRequiredException(TargetRequiredException)
A pull request target is required. It cannot be empty or null. A pull request target must contain the full values for the repository name, source branch, and destination branch for the pull request.
TargetsRequiredException(TargetsRequiredException)
An array of target objects is required. It cannot be empty or null.
TitleRequiredException(TitleRequiredException)
A pull request title is required. It cannot be empty or null.
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 CreatePullRequestError
impl CreatePullRequestError
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 CreatePullRequestError::Unhandled
variant from any error type.
Sourcepub fn generic(err: ErrorMetadata) -> Self
pub fn generic(err: ErrorMetadata) -> Self
Creates the CreatePullRequestError::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_client_request_token_required_exception(&self) -> bool
pub fn is_client_request_token_required_exception(&self) -> bool
Returns true
if the error kind is CreatePullRequestError::ClientRequestTokenRequiredException
.
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 CreatePullRequestError::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 CreatePullRequestError::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 CreatePullRequestError::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 CreatePullRequestError::EncryptionKeyNotFoundException
.
Returns true
if the error kind is CreatePullRequestError::EncryptionKeyUnavailableException
.
Sourcepub fn is_idempotency_parameter_mismatch_exception(&self) -> bool
pub fn is_idempotency_parameter_mismatch_exception(&self) -> bool
Returns true
if the error kind is CreatePullRequestError::IdempotencyParameterMismatchException
.
Sourcepub fn is_invalid_client_request_token_exception(&self) -> bool
pub fn is_invalid_client_request_token_exception(&self) -> bool
Returns true
if the error kind is CreatePullRequestError::InvalidClientRequestTokenException
.
Sourcepub fn is_invalid_description_exception(&self) -> bool
pub fn is_invalid_description_exception(&self) -> bool
Returns true
if the error kind is CreatePullRequestError::InvalidDescriptionException
.
Sourcepub fn is_invalid_reference_name_exception(&self) -> bool
pub fn is_invalid_reference_name_exception(&self) -> bool
Returns true
if the error kind is CreatePullRequestError::InvalidReferenceNameException
.
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 CreatePullRequestError::InvalidRepositoryNameException
.
Sourcepub fn is_invalid_target_exception(&self) -> bool
pub fn is_invalid_target_exception(&self) -> bool
Returns true
if the error kind is CreatePullRequestError::InvalidTargetException
.
Sourcepub fn is_invalid_targets_exception(&self) -> bool
pub fn is_invalid_targets_exception(&self) -> bool
Returns true
if the error kind is CreatePullRequestError::InvalidTargetsException
.
Sourcepub fn is_invalid_title_exception(&self) -> bool
pub fn is_invalid_title_exception(&self) -> bool
Returns true
if the error kind is CreatePullRequestError::InvalidTitleException
.
Sourcepub fn is_maximum_open_pull_requests_exceeded_exception(&self) -> bool
pub fn is_maximum_open_pull_requests_exceeded_exception(&self) -> bool
Returns true
if the error kind is CreatePullRequestError::MaximumOpenPullRequestsExceededException
.
Sourcepub fn is_multiple_repositories_in_pull_request_exception(&self) -> bool
pub fn is_multiple_repositories_in_pull_request_exception(&self) -> bool
Returns true
if the error kind is CreatePullRequestError::MultipleRepositoriesInPullRequestException
.
Sourcepub fn is_reference_does_not_exist_exception(&self) -> bool
pub fn is_reference_does_not_exist_exception(&self) -> bool
Returns true
if the error kind is CreatePullRequestError::ReferenceDoesNotExistException
.
Sourcepub fn is_reference_name_required_exception(&self) -> bool
pub fn is_reference_name_required_exception(&self) -> bool
Returns true
if the error kind is CreatePullRequestError::ReferenceNameRequiredException
.
Sourcepub fn is_reference_type_not_supported_exception(&self) -> bool
pub fn is_reference_type_not_supported_exception(&self) -> bool
Returns true
if the error kind is CreatePullRequestError::ReferenceTypeNotSupportedException
.
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 CreatePullRequestError::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 CreatePullRequestError::RepositoryNameRequiredException
.
Sourcepub fn is_source_and_destination_are_same_exception(&self) -> bool
pub fn is_source_and_destination_are_same_exception(&self) -> bool
Returns true
if the error kind is CreatePullRequestError::SourceAndDestinationAreSameException
.
Sourcepub fn is_target_required_exception(&self) -> bool
pub fn is_target_required_exception(&self) -> bool
Returns true
if the error kind is CreatePullRequestError::TargetRequiredException
.
Sourcepub fn is_targets_required_exception(&self) -> bool
pub fn is_targets_required_exception(&self) -> bool
Returns true
if the error kind is CreatePullRequestError::TargetsRequiredException
.
Sourcepub fn is_title_required_exception(&self) -> bool
pub fn is_title_required_exception(&self) -> bool
Returns true
if the error kind is CreatePullRequestError::TitleRequiredException
.
Trait Implementations§
Source§impl CreateUnhandledError for CreatePullRequestError
impl CreateUnhandledError for CreatePullRequestError
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 CreatePullRequestError
impl Debug for CreatePullRequestError
Source§impl Display for CreatePullRequestError
impl Display for CreatePullRequestError
Source§impl Error for CreatePullRequestError
impl Error for CreatePullRequestError
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<CreatePullRequestError> for Error
impl From<CreatePullRequestError> for Error
Source§fn from(err: CreatePullRequestError) -> Self
fn from(err: CreatePullRequestError) -> Self
Source§impl ProvideErrorMetadata for CreatePullRequestError
impl ProvideErrorMetadata for CreatePullRequestError
Source§fn meta(&self) -> &ErrorMetadata
fn meta(&self) -> &ErrorMetadata
Source§impl RequestId for CreatePullRequestError
impl RequestId for CreatePullRequestError
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 CreatePullRequestError
impl !RefUnwindSafe for CreatePullRequestError
impl Send for CreatePullRequestError
impl Sync for CreatePullRequestError
impl Unpin for CreatePullRequestError
impl !UnwindSafe for CreatePullRequestError
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);