#[non_exhaustive]
pub enum HistoricalMetricName {
Show 26 variants AbandonTime, AfterContactWorkTime, ApiContactsHandled, CallbackContactsHandled, ContactsAbandoned, ContactsAgentHungUpFirst, ContactsConsulted, ContactsHandled, ContactsHandledIncoming, ContactsHandledOutbound, ContactsHoldAbandons, ContactsMissed, ContactsQueued, ContactsTransferredIn, ContactsTransferredInFromQueue, ContactsTransferredOut, ContactsTransferredOutFromQueue, HandleTime, HoldTime, InteractionAndHoldTime, InteractionTime, Occupancy, QueuedTime, QueueAnswerTime, ServiceLevel, Unknown(UnknownVariantValue),
}
Expand description

When writing a match expression against HistoricalMetricName, 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 historicalmetricname = unimplemented!();
match historicalmetricname {
    HistoricalMetricName::AbandonTime => { /* ... */ },
    HistoricalMetricName::AfterContactWorkTime => { /* ... */ },
    HistoricalMetricName::ApiContactsHandled => { /* ... */ },
    HistoricalMetricName::CallbackContactsHandled => { /* ... */ },
    HistoricalMetricName::ContactsAbandoned => { /* ... */ },
    HistoricalMetricName::ContactsAgentHungUpFirst => { /* ... */ },
    HistoricalMetricName::ContactsConsulted => { /* ... */ },
    HistoricalMetricName::ContactsHandled => { /* ... */ },
    HistoricalMetricName::ContactsHandledIncoming => { /* ... */ },
    HistoricalMetricName::ContactsHandledOutbound => { /* ... */ },
    HistoricalMetricName::ContactsHoldAbandons => { /* ... */ },
    HistoricalMetricName::ContactsMissed => { /* ... */ },
    HistoricalMetricName::ContactsQueued => { /* ... */ },
    HistoricalMetricName::ContactsTransferredIn => { /* ... */ },
    HistoricalMetricName::ContactsTransferredInFromQueue => { /* ... */ },
    HistoricalMetricName::ContactsTransferredOut => { /* ... */ },
    HistoricalMetricName::ContactsTransferredOutFromQueue => { /* ... */ },
    HistoricalMetricName::HandleTime => { /* ... */ },
    HistoricalMetricName::HoldTime => { /* ... */ },
    HistoricalMetricName::InteractionAndHoldTime => { /* ... */ },
    HistoricalMetricName::InteractionTime => { /* ... */ },
    HistoricalMetricName::Occupancy => { /* ... */ },
    HistoricalMetricName::QueuedTime => { /* ... */ },
    HistoricalMetricName::QueueAnswerTime => { /* ... */ },
    HistoricalMetricName::ServiceLevel => { /* ... */ },
    other @ _ if other.as_str() == "NewFeature" => { /* handles a case for `NewFeature` */ },
    _ => { /* ... */ },
}

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

Variants (Non-exhaustive)§

This enum is marked as 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.
§

AbandonTime

§

AfterContactWorkTime

§

ApiContactsHandled

§

CallbackContactsHandled

§

ContactsAbandoned

§

ContactsAgentHungUpFirst

§

ContactsConsulted

§

ContactsHandled

§

ContactsHandledIncoming

§

ContactsHandledOutbound

§

ContactsHoldAbandons

§

ContactsMissed

§

ContactsQueued

§

ContactsTransferredIn

§

ContactsTransferredInFromQueue

§

ContactsTransferredOut

§

ContactsTransferredOutFromQueue

§

HandleTime

§

HoldTime

§

InteractionAndHoldTime

§

InteractionTime

§

Occupancy

§

QueuedTime

§

QueueAnswerTime

§

ServiceLevel

§

Unknown(UnknownVariantValue)

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

Implementations§

source§

impl HistoricalMetricName

source

pub fn as_str(&self) -> &str

Returns the &str value of the enum member.

source

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

Returns all the &str representations of the enum members.

Trait Implementations§

source§

impl AsRef<str> for HistoricalMetricName

source§

fn as_ref(&self) -> &str

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

impl Clone for HistoricalMetricName

source§

fn clone(&self) -> HistoricalMetricName

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for HistoricalMetricName

source§

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

Formats the value using the given formatter. Read more
source§

impl From<&str> for HistoricalMetricName

source§

fn from(s: &str) -> Self

Converts to this type from the input type.
source§

impl FromStr for HistoricalMetricName

§

type Err = Infallible

The associated error which can be returned from parsing.
source§

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

Parses a string s to return a value of this type. Read more
source§

impl Hash for HistoricalMetricName

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl Ord for HistoricalMetricName

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval. Read more
source§

impl PartialEq<HistoricalMetricName> for HistoricalMetricName

source§

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

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

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.
source§

impl PartialOrd<HistoricalMetricName> for HistoricalMetricName

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

impl Eq for HistoricalMetricName

source§

impl StructuralEq for HistoricalMetricName

source§

impl StructuralPartialEq for HistoricalMetricName

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same<T> for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more