Enum UpdatePullRequestDescriptionError

#[non_exhaustive]
pub enum UpdatePullRequestDescriptionError {
    InvalidDescriptionException(InvalidDescriptionException),
    InvalidPullRequestIdException(InvalidPullRequestIdException),
    PullRequestAlreadyClosedException(PullRequestAlreadyClosedException),
    PullRequestDoesNotExistException(PullRequestDoesNotExistException),
    PullRequestIdRequiredException(PullRequestIdRequiredException),
    Unhandled(Unhandled),
}

Error type for the UpdatePullRequestDescriptionError operation.

Variants (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.

InvalidDescriptionException(InvalidDescriptionException)

The pull request description is not valid. Descriptions cannot be more than 1,000 characters.

InvalidPullRequestIdException(InvalidPullRequestIdException)

The pull request ID is not valid. Make sure that you have provided the full ID and that the pull request is in the specified repository, and then try again.

PullRequestAlreadyClosedException(PullRequestAlreadyClosedException)

The pull request status cannot be updated because it is already closed.

PullRequestDoesNotExistException(PullRequestDoesNotExistException)

The pull request ID could not be found. Make sure that you have specified the correct repository name and pull request ID, and then try again.

PullRequestIdRequiredException(PullRequestIdRequiredException)

A pull request ID is required, but none was provided.

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

impl UpdatePullRequestDescriptionError

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

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

pub fn generic(err: ErrorMetadata) -> Self

Creates the UpdatePullRequestDescriptionError::Unhandled variant from an ErrorMetadata.

pub fn meta(&self) -> &ErrorMetadata

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

pub fn is_invalid_description_exception(&self) -> bool

Returns true if the error kind is UpdatePullRequestDescriptionError::InvalidDescriptionException.

pub fn is_invalid_pull_request_id_exception(&self) -> bool

Returns true if the error kind is UpdatePullRequestDescriptionError::InvalidPullRequestIdException.

pub fn is_pull_request_already_closed_exception(&self) -> bool

Returns true if the error kind is UpdatePullRequestDescriptionError::PullRequestAlreadyClosedException.

pub fn is_pull_request_does_not_exist_exception(&self) -> bool

Returns true if the error kind is UpdatePullRequestDescriptionError::PullRequestDoesNotExistException.

pub fn is_pull_request_id_required_exception(&self) -> bool

Returns true if the error kind is UpdatePullRequestDescriptionError::PullRequestIdRequiredException.

Trait Implementations

impl CreateUnhandledError for UpdatePullRequestDescriptionError

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.

impl Debug for UpdatePullRequestDescriptionError

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

Formats the value using the given formatter.

impl Display for UpdatePullRequestDescriptionError

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

Formats the value using the given formatter.

impl Error for UpdatePullRequestDescriptionError

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

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

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

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

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.

impl From<UpdatePullRequestDescriptionError> for Error

fn from(err: UpdatePullRequestDescriptionError) -> Self

Converts to this type from the input type.

impl ProvideErrorKind for UpdatePullRequestDescriptionError

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

Returns the code for this error if one exists

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

Returns the ErrorKind when the error is modeled as retryable

impl ProvideErrorMetadata for UpdatePullRequestDescriptionError

fn meta(&self) -> &ErrorMetadata

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

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

Returns the error code if it’s available.

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

Returns the error message, if there is one.

impl RequestId for UpdatePullRequestDescriptionError

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

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