Enum DeliveryReason 

#[non_exhaustive]
pub enum DeliveryReason {
    ArtifactReadFailed,
    ArtifactSourceMismatch,
    ArtifactSourceMissing,
    BuildNotFound,
    BuildReadFailed,
    BuildResultScopeMismatch,
    DeliveryNotConfigured,
    DeliverySourceKindChanged,
    DuplicateLogicalRepository,
    DuplicateOrInvalidRepository,
    EnvironmentDeleted,
    EnvironmentNotActive,
    EnvironmentNotFound,
    EnvironmentReadFailed,
    ExportCredentialsMissing,
    ExportCredentialExpiryInvalid,
    ExportDestinationInvalid,
    ExportExistingObjectMismatch,
    ExportPutFailed,
    ExportReconciliationReadFailed,
    ExportRoleAssumptionFailed,
    GithubAccessDenied,
    GithubBaseNotFound,
    GithubBranchConflict,
    GithubNotFound,
    GithubRateLimited,
    GithubRepositoryChanged,
    GithubRepositoryNotFound,
    GithubRequestFailed,
    GithubRequestRejected,
    GithubResponseInvalid,
    GreenAttemptNotSuccessful,
    GreenCompletionNotObserved,
    IncompleteSourceReference,
    InvalidArchiveDigest,
    InvalidArtifactSource,
    InvalidCompletedManifest,
    InvalidExportReceipt,
    InvalidGithubProvenance,
    InvalidS3Destination,
    InvalidServiceReceipt,
    InvalidSourceInventory,
    InvalidSourceManifest,
    InvalidSourceReference,
    IssueIntegrityFailure,
    IssueNotFound,
    ManifestInventoryMismatch,
    ManifestProvenanceChanged,
    ManifestRepositorySetMismatch,
    ManifestScopeOrVersionMismatch,
    MissingBuildResult,
    MissingCompletedManifest,
    MissingResultDigest,
    MissingSourceManifest,
    MissingSourceTarget,
    PatchNotApplicable,
    PatchNotSelected,
    PatchStorageIdentityMissing,
    PatchUnsupported,
    PublicationOutcomeUnknownAfterRetryLimit,
    PublisherDeadlineExceeded,
    ResultCompletedManifestMismatch,
    ResultSourceBindingMismatch,
    S3AccessDenied,
    S3SourcePrefixOverlap,
    ServiceCopyDigestMismatch,
    ServiceObjectReadFailed,
    ServiceObjectTooLarge,
    ServiceReceiptOutsideIssue,
    SourceIntegrationChanged,
    SourceIntegrationInvalid,
    SourceIntegrationReadFailed,
    SourceIntegrationUnresolved,
    SourceObjectDigestMismatch,
    SourceReferenceOutsideBuild,
    SourceTargetBuildMismatch,
    UnknownRepository,
    UnknownSourceProvider,
    UnsupportedEnvironmentSchema,
    GithubDestinationNotEnabled,
    PatchCreationPolicyDisabled,
    Unknown(UnknownVariantValue),
}

When writing a match expression against DeliveryReason, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

Here is an example of how you can make a match expression forward-compatible:

# let deliveryreason = unimplemented!();
match deliveryreason {
    DeliveryReason::ArtifactReadFailed => { /* ... */ },
    DeliveryReason::ArtifactSourceMismatch => { /* ... */ },
    DeliveryReason::ArtifactSourceMissing => { /* ... */ },
    DeliveryReason::BuildNotFound => { /* ... */ },
    DeliveryReason::BuildReadFailed => { /* ... */ },
    DeliveryReason::BuildResultScopeMismatch => { /* ... */ },
    DeliveryReason::DeliveryNotConfigured => { /* ... */ },
    DeliveryReason::DeliverySourceKindChanged => { /* ... */ },
    DeliveryReason::DuplicateLogicalRepository => { /* ... */ },
    DeliveryReason::DuplicateOrInvalidRepository => { /* ... */ },
    DeliveryReason::EnvironmentDeleted => { /* ... */ },
    DeliveryReason::EnvironmentNotActive => { /* ... */ },
    DeliveryReason::EnvironmentNotFound => { /* ... */ },
    DeliveryReason::EnvironmentReadFailed => { /* ... */ },
    DeliveryReason::ExportCredentialsMissing => { /* ... */ },
    DeliveryReason::ExportCredentialExpiryInvalid => { /* ... */ },
    DeliveryReason::ExportDestinationInvalid => { /* ... */ },
    DeliveryReason::ExportExistingObjectMismatch => { /* ... */ },
    DeliveryReason::ExportPutFailed => { /* ... */ },
    DeliveryReason::ExportReconciliationReadFailed => { /* ... */ },
    DeliveryReason::ExportRoleAssumptionFailed => { /* ... */ },
    DeliveryReason::GithubAccessDenied => { /* ... */ },
    DeliveryReason::GithubBaseNotFound => { /* ... */ },
    DeliveryReason::GithubBranchConflict => { /* ... */ },
    DeliveryReason::GithubNotFound => { /* ... */ },
    DeliveryReason::GithubRateLimited => { /* ... */ },
    DeliveryReason::GithubRepositoryChanged => { /* ... */ },
    DeliveryReason::GithubRepositoryNotFound => { /* ... */ },
    DeliveryReason::GithubRequestFailed => { /* ... */ },
    DeliveryReason::GithubRequestRejected => { /* ... */ },
    DeliveryReason::GithubResponseInvalid => { /* ... */ },
    DeliveryReason::GreenAttemptNotSuccessful => { /* ... */ },
    DeliveryReason::GreenCompletionNotObserved => { /* ... */ },
    DeliveryReason::IncompleteSourceReference => { /* ... */ },
    DeliveryReason::InvalidArchiveDigest => { /* ... */ },
    DeliveryReason::InvalidArtifactSource => { /* ... */ },
    DeliveryReason::InvalidCompletedManifest => { /* ... */ },
    DeliveryReason::InvalidExportReceipt => { /* ... */ },
    DeliveryReason::InvalidGithubProvenance => { /* ... */ },
    DeliveryReason::InvalidS3Destination => { /* ... */ },
    DeliveryReason::InvalidServiceReceipt => { /* ... */ },
    DeliveryReason::InvalidSourceInventory => { /* ... */ },
    DeliveryReason::InvalidSourceManifest => { /* ... */ },
    DeliveryReason::InvalidSourceReference => { /* ... */ },
    DeliveryReason::IssueIntegrityFailure => { /* ... */ },
    DeliveryReason::IssueNotFound => { /* ... */ },
    DeliveryReason::ManifestInventoryMismatch => { /* ... */ },
    DeliveryReason::ManifestProvenanceChanged => { /* ... */ },
    DeliveryReason::ManifestRepositorySetMismatch => { /* ... */ },
    DeliveryReason::ManifestScopeOrVersionMismatch => { /* ... */ },
    DeliveryReason::MissingBuildResult => { /* ... */ },
    DeliveryReason::MissingCompletedManifest => { /* ... */ },
    DeliveryReason::MissingResultDigest => { /* ... */ },
    DeliveryReason::MissingSourceManifest => { /* ... */ },
    DeliveryReason::MissingSourceTarget => { /* ... */ },
    DeliveryReason::PatchNotApplicable => { /* ... */ },
    DeliveryReason::PatchNotSelected => { /* ... */ },
    DeliveryReason::PatchStorageIdentityMissing => { /* ... */ },
    DeliveryReason::PatchUnsupported => { /* ... */ },
    DeliveryReason::PublicationOutcomeUnknownAfterRetryLimit => { /* ... */ },
    DeliveryReason::PublisherDeadlineExceeded => { /* ... */ },
    DeliveryReason::ResultCompletedManifestMismatch => { /* ... */ },
    DeliveryReason::ResultSourceBindingMismatch => { /* ... */ },
    DeliveryReason::S3AccessDenied => { /* ... */ },
    DeliveryReason::S3SourcePrefixOverlap => { /* ... */ },
    DeliveryReason::ServiceCopyDigestMismatch => { /* ... */ },
    DeliveryReason::ServiceObjectReadFailed => { /* ... */ },
    DeliveryReason::ServiceObjectTooLarge => { /* ... */ },
    DeliveryReason::ServiceReceiptOutsideIssue => { /* ... */ },
    DeliveryReason::SourceIntegrationChanged => { /* ... */ },
    DeliveryReason::SourceIntegrationInvalid => { /* ... */ },
    DeliveryReason::SourceIntegrationReadFailed => { /* ... */ },
    DeliveryReason::SourceIntegrationUnresolved => { /* ... */ },
    DeliveryReason::SourceObjectDigestMismatch => { /* ... */ },
    DeliveryReason::SourceReferenceOutsideBuild => { /* ... */ },
    DeliveryReason::SourceTargetBuildMismatch => { /* ... */ },
    DeliveryReason::UnknownRepository => { /* ... */ },
    DeliveryReason::UnknownSourceProvider => { /* ... */ },
    DeliveryReason::UnsupportedEnvironmentSchema => { /* ... */ },
    DeliveryReason::GithubDestinationNotEnabled => { /* ... */ },
    DeliveryReason::PatchCreationPolicyDisabled => { /* ... */ },
    other @ _ if other.as_str() == "NewFeature" => { /* handles a case for `NewFeature` */ },
    _ => { /* ... */ },
}

The above code demonstrates that when deliveryreason represents NewFeature, the execution path will lead to the second last match arm, even though the enum does not contain a variant DeliveryReason::NewFeature in the current version of SDK. The reason is that the variable other, created by the @ operator, is bound to DeliveryReason::Unknown(UnknownVariantValue("NewFeature".to_owned())) and calling as_str on it yields "NewFeature". This match expression is forward-compatible when executed with a newer version of SDK where the variant DeliveryReason::NewFeature is defined. Specifically, when deliveryreason represents NewFeature, the execution path will hit the second last match arm as before by virtue of calling as_str on DeliveryReason::NewFeature also yielding "NewFeature".

Explicitly matching on the Unknown variant should be avoided for two reasons:

• The inner data UnknownVariantValue is opaque, and no further information can be extracted.
• It might inadvertently shadow other intended match arms.

Cause of a PATCH delivery’s current state; used only by DeliveryState.reason. These are outcomes of one delivery lifecycle, not shared operation error enums. The two existing skip-code wire values are retained for compatibility.

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.

ArtifactReadFailed

ArtifactSourceMismatch

ArtifactSourceMissing

BuildNotFound

BuildReadFailed

BuildResultScopeMismatch

DeliveryNotConfigured

DeliverySourceKindChanged

DuplicateLogicalRepository

DuplicateOrInvalidRepository

EnvironmentDeleted

EnvironmentNotActive

EnvironmentNotFound

EnvironmentReadFailed

ExportCredentialsMissing

ExportCredentialExpiryInvalid

ExportDestinationInvalid

ExportExistingObjectMismatch

ExportPutFailed

ExportReconciliationReadFailed

ExportRoleAssumptionFailed

GithubAccessDenied

GithubBaseNotFound

The pinned Build commit or one of its trees is no longer readable.

GithubBranchConflict

The deterministic delivery branch or its pull request names different content.

GithubNotFound

GithubRateLimited

GithubRepositoryChanged

GithubRepositoryNotFound

GithubRequestFailed

GithubRequestRejected

GithubResponseInvalid

GreenAttemptNotSuccessful

The GREEN attempt that staged the patch ended without PatchDelivered, or a later attempt superseded it.

GreenCompletionNotObserved

The staging GREEN attempt never completed within the delivery wait bound.

IncompleteSourceReference

InvalidArchiveDigest

InvalidArtifactSource

InvalidCompletedManifest

InvalidExportReceipt

InvalidGithubProvenance

InvalidS3Destination

InvalidServiceReceipt

InvalidSourceInventory

InvalidSourceManifest

InvalidSourceReference

IssueIntegrityFailure

IssueNotFound

ManifestInventoryMismatch

ManifestProvenanceChanged

ManifestRepositorySetMismatch

ManifestScopeOrVersionMismatch

MissingBuildResult

MissingCompletedManifest

MissingResultDigest

MissingSourceManifest

MissingSourceTarget

PatchNotApplicable

A hunk does not match the exact pinned file bytes it was generated against.

PatchNotSelected

The GREEN attempt completed with PATCH_STAGED and did not select this patch.

PatchStorageIdentityMissing

PatchUnsupported

Rename, mode change, binary content, workflow file or unsafe path.

PublicationOutcomeUnknownAfterRetryLimit

PublisherDeadlineExceeded

ResultCompletedManifestMismatch

ResultSourceBindingMismatch

S3AccessDenied

S3SourcePrefixOverlap

ServiceCopyDigestMismatch

ServiceObjectReadFailed

ServiceObjectTooLarge

ServiceReceiptOutsideIssue

SourceIntegrationChanged

SourceIntegrationInvalid

SourceIntegrationReadFailed

SourceIntegrationUnresolved

SourceObjectDigestMismatch

SourceReferenceOutsideBuild

SourceTargetBuildMismatch

UnknownRepository

UnknownSourceProvider

UnsupportedEnvironmentSchema

GithubDestinationNotEnabled

PatchCreationPolicyDisabled

Unknown(UnknownVariantValue)

👎Deprecated:

Don’t directly match on Unknown. See the docs on this enum for the correct way to handle unknown variants.

Unknown contains new variants that have been added since this code was generated.

Implementations

impl DeliveryReason

pub fn as_str(&self) -> &str

Returns the &str value of the enum member.

pub const fn values() -> &'static [&'static str]

Returns all the &str representations of the enum members.

impl DeliveryReason

pub fn try_parse(value: &str) -> Result<Self, UnknownVariantError>

Parses the enum value while disallowing unknown variants.

Unknown variants will result in an error.

Trait Implementations

impl AsRef<str> for DeliveryReason

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for DeliveryReason

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DeliveryReason

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

Formats the value using the given formatter.

impl Display for DeliveryReason

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

Formats the value using the given formatter.

impl Eq for DeliveryReason

impl From<&str> for DeliveryReason

fn from(s: &str) -> Self

Converts to this type from the input type.

impl FromStr for DeliveryReason

type Err = !

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, <Self as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for DeliveryReason

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for DeliveryReason

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for DeliveryReason

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialOrd for DeliveryReason

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for DeliveryReason