Enum aws_sdk_sesv2::types::Metric

#[non_exhaustive]
pub enum Metric {
    Click,
    Complaint,
    Delivery,
    DeliveryClick,
    DeliveryComplaint,
    DeliveryOpen,
    Open,
    PermanentBounce,
    Send,
    TransientBounce,
    Unknown(UnknownVariantValue),
}

When writing a match expression against Metric, 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 metric = unimplemented!();
match metric {
    Metric::Click => { /* ... */ },
    Metric::Complaint => { /* ... */ },
    Metric::Delivery => { /* ... */ },
    Metric::DeliveryClick => { /* ... */ },
    Metric::DeliveryComplaint => { /* ... */ },
    Metric::DeliveryOpen => { /* ... */ },
    Metric::Open => { /* ... */ },
    Metric::PermanentBounce => { /* ... */ },
    Metric::Send => { /* ... */ },
    Metric::TransientBounce => { /* ... */ },
    other @ _ if other.as_str() == "NewFeature" => { /* handles a case for `NewFeature` */ },
    _ => { /* ... */ },
}

The above code demonstrates that when metric represents NewFeature, the execution path will lead to the second last match arm, even though the enum does not contain a variant Metric::NewFeature in the current version of SDK. The reason is that the variable other, created by the @ operator, is bound to Metric::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 Metric::NewFeature is defined. Specifically, when metric represents NewFeature, the execution path will hit the second last match arm as before by virtue of calling as_str on Metric::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.

The metric to export, can be one of the following:

• SEND - Emails sent eligible for tracking in the VDM dashboard. This excludes emails sent to the mailbox simulator and emails addressed to more than one recipient.

• COMPLAINT - Complaints received for your account. This excludes complaints from the mailbox simulator, those originating from your account-level suppression list (if enabled), and those for emails addressed to more than one recipient

• PERMANENT_BOUNCE - Permanent bounces - i.e., feedback received for emails sent to non-existent mailboxes. Excludes bounces from the mailbox simulator, those originating from your account-level suppression list (if enabled), and those for emails addressed to more than one recipient.

• TRANSIENT_BOUNCE - Transient bounces - i.e., feedback received for delivery failures excluding issues with non-existent mailboxes. Excludes bounces from the mailbox simulator, and those for emails addressed to more than one recipient.

• OPEN - Unique open events for emails including open trackers. Excludes opens for emails addressed to more than one recipient.

• CLICK - Unique click events for emails including wrapped links. Excludes clicks for emails addressed to more than one recipient.

• DELIVERY - Successful deliveries for email sending attempts. Excludes deliveries to the mailbox simulator and for emails addressed to more than one recipient.

• DELIVERY_OPEN - Successful deliveries for email sending attempts. Excludes deliveries to the mailbox simulator, for emails addressed to more than one recipient, and emails without open trackers.

• DELIVERY_CLICK - Successful deliveries for email sending attempts. Excludes deliveries to the mailbox simulator, for emails addressed to more than one recipient, and emails without click trackers.

• DELIVERY_COMPLAINT - Successful deliveries for email sending attempts. Excludes deliveries to the mailbox simulator, for emails addressed to more than one recipient, and emails addressed to recipients hosted by ISPs with which Amazon SES does not have a feedback loop agreement.

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.

Click

Complaint

Delivery

DeliveryClick

DeliveryComplaint

DeliveryOpen

Open

PermanentBounce

Send

TransientBounce

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 Metric

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 Metric

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 Metric

fn as_ref(&self) -> &str

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

impl Clone for Metric

fn clone(&self) -> Metric

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Metric

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

Formats the value using the given formatter.

impl From<&str> for Metric

fn from(s: &str) -> Self

Converts to this type from the input type.

impl FromStr for Metric

type Err = Infallible

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 Metric

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 Metric

fn cmp(&self, other: &Metric) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Metric

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Metric

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Eq for Metric

impl StructuralEq for Metric

impl StructuralPartialEq for Metric